From 4519d04efcebea82c271dc0b92d27f554ee2f1b5 Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Tue, 3 Oct 2023 15:47:15 -0400 Subject: [PATCH] [Doc] Add admonitions redirecting users to stable docs --- doc/sphinx/develop/index.md | 5 +++++ doc/sphinx/index.md | 5 +++++ doc/sphinx/install/index.md | 5 +++++ doc/sphinx/reference/index.md | 7 +++++++ doc/sphinx/reference/science/reactors/index.md | 5 +++++ doc/sphinx/userguide/index.md | 6 ++++++ 6 files changed, 33 insertions(+) diff --git a/doc/sphinx/develop/index.md b/doc/sphinx/develop/index.md index 5b624bab91a..a46aff043b5 100644 --- a/doc/sphinx/develop/index.md +++ b/doc/sphinx/develop/index.md @@ -1,5 +1,10 @@ # Develop +```{caution} +This page is a work in progress. For compilation instructions for Cantera 3.0, please +see this page. +``` + - Compilation instructions - Explanations of how the code works - Guides to introducing new models diff --git a/doc/sphinx/index.md b/doc/sphinx/index.md index 65b2a988f2e..ff94facc64d 100644 --- a/doc/sphinx/index.md +++ b/doc/sphinx/index.md @@ -1,5 +1,10 @@ # Table of Contents +```{caution} +This page is a work in progress. For documentation and tutorials for Cantera 3.0, please +see this page. +``` + ```{toctree} :maxdepth: 1 diff --git a/doc/sphinx/install/index.md b/doc/sphinx/install/index.md index 768944a55f8..c5736008a79 100644 --- a/doc/sphinx/install/index.md +++ b/doc/sphinx/install/index.md @@ -1,5 +1,10 @@ # Install +```{caution} +This page is a work in progress. For installation instructions for Cantera 3.0, please +see this page. +``` + ```{toctree} :maxdepth: 1 diff --git a/doc/sphinx/reference/index.md b/doc/sphinx/reference/index.md index aaa23f014bf..adf988039fa 100644 --- a/doc/sphinx/reference/index.md +++ b/doc/sphinx/reference/index.md @@ -3,6 +3,13 @@ This pages provide detailed reference documentation for Cantera. +```{caution} +This page is a work in progress. For more complete documentation of the current Cantera +release (Cantera 3.0), please see the +documentation index and the +Science & Theory Manual. +``` + ## Programming Reference These sections document the classes and functions that define the Cantera interface for diff --git a/doc/sphinx/reference/science/reactors/index.md b/doc/sphinx/reference/science/reactors/index.md index 846c3b643f0..fe80fddfd33 100644 --- a/doc/sphinx/reference/science/reactors/index.md +++ b/doc/sphinx/reference/science/reactors/index.md @@ -1,5 +1,10 @@ # Reactors and Reactor Networks +```{caution} +This page is a work in progress. For more complete documentation of the current Cantera +release (Cantera 3.0), please see this page. +``` + ## Reactors A Cantera *reactor* represents the simplest form of a chemically reacting system. It diff --git a/doc/sphinx/userguide/index.md b/doc/sphinx/userguide/index.md index b7734d0fa89..4a8b3a551cd 100644 --- a/doc/sphinx/userguide/index.md +++ b/doc/sphinx/userguide/index.md @@ -1,7 +1,13 @@ # User Guide +```{caution} +This page is a work in progress. For tutorials covering the current Cantera +release (Cantera 3.0), please see this page. +``` + ## Introductory Tutorials + {doc}`Getting Started with Python ` * Task/goal-oriented guides