diff --git a/docs/conf.py b/docs/conf.py index 06ff71f..556f17d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -52,7 +52,6 @@ # ones. extensions = [ "sphinx.ext.todo", - "sphinx_rtd_theme", "nbsphinx", "sphinx.ext.graphviz", "sphinx.ext.intersphinx", @@ -121,8 +120,8 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -# -html_theme = "sphinx_rtd_theme" + +html_theme = "pydata_sphinx_theme" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -130,6 +129,13 @@ html_static_path = ["_static"] html_css_files = ["style.css"] +# Here we control which pages have what sidebars +html_sidebars = { + "index": [], + "overview": [], + "contributing/**": ["search-field.html", "sidebar-nav-bs.html"], +} + todo_include_todos = not read_the_docs_build diff --git a/docs/contributing/contributing.rst b/docs/contributing/contributing.rst index ae59df4..aa753fb 100644 --- a/docs/contributing/contributing.rst +++ b/docs/contributing/contributing.rst @@ -83,3 +83,13 @@ before enabling automated checks. Please follow the `GitHub Code of Conduct `_ for respectful collaboration. + +.. toctree:: + :maxdepth: 2 + :hidden: + + environment + guidelines + code_style + testing + documentation diff --git a/docs/index.rst b/docs/index.rst index 69444c9..5c16cab 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,23 +13,6 @@ framework it seeks to handle many of the complexities that meteorological organisations will share, allowing them to easily train models from existing recipes but with their own data. -.. toctree:: - :maxdepth: 1 - :caption: The Anemoi Framework - - overview - -.. toctree:: - :maxdepth: 1 - :caption: Contributing - - contributing/contributing.rst - contributing/environment.rst - contributing/guidelines.rst - contributing/code_style.rst - contributing/testing.rst - contributing/documentation.rst - ************** Dependencies ************** @@ -37,7 +20,7 @@ models from existing recipes but with their own data. .. raw:: html
- + Fallback image description @@ -64,4 +47,11 @@ optional dependencies. *Anemoi* is available under the open source `Apache License`__. +.. toctree:: + :maxdepth: 1 + :hidden: + + overview + contributing/contributing.rst + .. __: http://www.apache.org/licenses/LICENSE-2.0.html diff --git a/pyproject.toml b/pyproject.toml index ae46c3f..c710a5d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -20,8 +20,8 @@ dependencies = [ "nbsphinx", "pandoc", "pre-commit", + "pydata-sphinx-theme", "requests", "sphinx", "sphinx-argparse<0.5", - "sphinx-rtd-theme", ]