Skip to content

Commit 7ab7a95

Browse files
authored
Switch docs to furo theme (#420)
* Switch docs to furo theme * Added logo to sidebar, navigation with keys * Removed indexes from top level page; moved toctree to contents.rst
1 parent 4c30d78 commit 7ab7a95

4 files changed

Lines changed: 22 additions & 25 deletions

File tree

devtools/conda-envs/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ channels:
55
dependencies:
66
- python<3.13
77
- sphinx
8-
- sphinx-rtd-theme
8+
- furo
99
- myst-nb
1010
- myst-parser>=0.14
1111
- docutils

docs/conf.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,15 @@
1212

1313
import sys
1414
import os
15-
import sphinx_rtd_theme
1615

1716
sys.path.insert(0, os.path.abspath("."))
1817

1918

2019
# -- General configuration ---------------------------------------------------
2120
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
2221

22+
master_doc = "contents"
23+
2324
extensions = [
2425
"sphinx.ext.autodoc",
2526
"sphinx.ext.napoleon",
@@ -58,7 +59,12 @@
5859
# -- Options for HTML output -------------------------------------------------
5960
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
6061

61-
html_theme = "sphinx_rtd_theme"
62+
html_theme = "furo"
63+
html_logo = "assets/logo/logo_full_horizontal_inverted.png"
64+
html_theme_options = {
65+
"sidebar_hide_name": True,
66+
"navigation_with_keys": True,
67+
}
6268

6369
# -- Options for MystNB ------------------------------------------------------
6470

docs/contents.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. toctree::
2+
:maxdepth: 1
3+
:caption: Contents:
4+
5+
6+
./user_guide
7+
./tutorials/index
8+
./deployment
9+
./compute
10+
./operations
11+
./development
12+
./api
13+
CHANGELOG

docs/index.rst

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -42,25 +42,3 @@ and the :ref:`developer-guide` for details on how the components of this archite
4242
.. _Open Molecular Software Foundation: https://omsf.io
4343
.. _OpenForceField: https://openforcefield.org
4444
.. _OpenFreeEnergy: https://openfree.energy/
45-
46-
.. toctree::
47-
:maxdepth: 1
48-
:caption: Contents:
49-
50-
51-
./user_guide
52-
./tutorials/index
53-
./deployment
54-
./compute
55-
./operations
56-
./development
57-
./api
58-
CHANGELOG
59-
60-
61-
Indices and tables
62-
==================
63-
64-
* :ref:`genindex`
65-
* :ref:`modindex`
66-
* :ref:`search`

0 commit comments

Comments
 (0)