Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@
# ones.
extensions = [
"sphinx.ext.todo",
"sphinx_rtd_theme",
"nbsphinx",
"sphinx.ext.graphviz",
"sphinx.ext.intersphinx",
Expand Down Expand Up @@ -121,15 +120,22 @@

# 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,
# so a file named "default.css" will overwrite the builtin "default.css".
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

Expand Down
10 changes: 10 additions & 0 deletions docs/contributing/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,13 @@ before enabling automated checks.
Please follow the `GitHub Code of Conduct
<https://docs.github.com/en/site-policy/github-terms/github-community-code-of-conduct>`_
for respectful collaboration.

.. toctree::
:maxdepth: 2
:hidden:

environment
guidelines
code_style
testing
documentation
26 changes: 8 additions & 18 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,31 +13,14 @@ 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
**************

.. raw:: html

<center>
<object type="image/svg+xml" data="_static/dependencies.svg" width="75%" height="auto">
<object type="image/svg+xml" data="_static/dependencies.svg" height="35%">
<img src="_static/dependencies.png" alt="Fallback image description">
</object>
</center>
Expand All @@ -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
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ dependencies = [
"nbsphinx",
"pandoc",
"pre-commit",
"pydata-sphinx-theme",
"requests",
"sphinx",
"sphinx-argparse<0.5",
"sphinx-rtd-theme",
]