From 8084eae338dcb8194b2f80b3f7b6c14dfe66bb88 Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Fri, 29 Sep 2023 21:11:16 -0400 Subject: [PATCH] [Doc] Create skeleton for revised layout --- doc/doxygen/header.html | 6 ++++- doc/sphinx/_templates/cantera-org-links.html | 24 -------------------- doc/sphinx/conf.py | 2 +- doc/sphinx/develop.md | 5 ++++ doc/sphinx/index.rst | 5 +++- doc/sphinx/install.md | 8 +++++++ doc/sphinx/install/conda.md | 6 +++++ doc/sphinx/install/pip.md | 6 +++++ doc/sphinx/userguide.md | 4 ++++ 9 files changed, 39 insertions(+), 27 deletions(-) create mode 100644 doc/sphinx/develop.md create mode 100644 doc/sphinx/install.md create mode 100644 doc/sphinx/install/conda.md create mode 100644 doc/sphinx/install/pip.md create mode 100644 doc/sphinx/userguide.md diff --git a/doc/doxygen/header.html b/doc/doxygen/header.html index 278a670d5..7403a813f 100644 --- a/doc/doxygen/header.html +++ b/doc/doxygen/header.html @@ -71,8 +71,12 @@ $extrastylesheet
diff --git a/doc/sphinx/_templates/cantera-org-links.html b/doc/sphinx/_templates/cantera-org-links.html index 101b25025..9946aac0d 100644 --- a/doc/sphinx/_templates/cantera-org-links.html +++ b/doc/sphinx/_templates/cantera-org-links.html @@ -1,31 +1,7 @@ diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py index 99b4f4bdf..382a86fc0 100644 --- a/doc/sphinx/conf.py +++ b/doc/sphinx/conf.py @@ -296,7 +296,7 @@ html_theme = 'pydata_sphinx_theme' html_theme_options = { "show_toc_level": 2, - "navbar_center": ["cantera-org-links", "navbar-nav"], + "navbar_center": ["navbar-nav", "cantera-org-links"], "navbar_end": ["version-switcher", "theme-switcher", "navbar-icon-links"], "show_prev_next": False, "logo": { diff --git a/doc/sphinx/develop.md b/doc/sphinx/develop.md new file mode 100644 index 000000000..5b624bab9 --- /dev/null +++ b/doc/sphinx/develop.md @@ -0,0 +1,5 @@ +# Develop + +- Compilation instructions +- Explanations of how the code works +- Guides to introducing new models diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst index ec9b012bb..562975f90 100644 --- a/doc/sphinx/index.rst +++ b/doc/sphinx/index.rst @@ -4,5 +4,8 @@ Table of Contents .. toctree:: :maxdepth: 1 - reference + install + userguide examples + reference + develop diff --git a/doc/sphinx/install.md b/doc/sphinx/install.md new file mode 100644 index 000000000..759f3f2ba --- /dev/null +++ b/doc/sphinx/install.md @@ -0,0 +1,8 @@ +# Install + +```{toctree} +:maxdepth: 1 + +install/conda +install/pip +``` diff --git a/doc/sphinx/install/conda.md b/doc/sphinx/install/conda.md new file mode 100644 index 000000000..110628f22 --- /dev/null +++ b/doc/sphinx/install/conda.md @@ -0,0 +1,6 @@ +# Installing with Conda + +```{caution} +This page is a work in progress. For current Conda installation instructions, see +this page. +``` diff --git a/doc/sphinx/install/pip.md b/doc/sphinx/install/pip.md new file mode 100644 index 000000000..4f8d2a2d0 --- /dev/null +++ b/doc/sphinx/install/pip.md @@ -0,0 +1,6 @@ +# Installing with Pip + +```{caution} +This page is a work in progress. For current Pip installation instructions, see +this page. +``` diff --git a/doc/sphinx/userguide.md b/doc/sphinx/userguide.md new file mode 100644 index 000000000..53d3d1506 --- /dev/null +++ b/doc/sphinx/userguide.md @@ -0,0 +1,4 @@ +# User Guide + +* Tutorials +* Task/goal-oriented guides