Skip to content

Commit

Permalink
DOC: Move to 'furo' theme
Browse files Browse the repository at this point in the history
Also adds the copybutton extensions. This theme is more modern and
provdes better in-page navigation.
  • Loading branch information
mferrera committed Feb 5, 2025
1 parent ace38f4 commit b75449f
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 17 deletions.
13 changes: 3 additions & 10 deletions docs/src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ def filter(self, record: logging.LogRecord) -> bool:
"sphinx_togglebutton",
"sphinxcontrib.apidoc",
"sphinxcontrib.autodoc_pydantic",
"sphinx_copybutton",
]

myst_enable_extensions = [
Expand Down Expand Up @@ -120,16 +121,8 @@ def set_myst_substitutions() -> dict[str, str]:

pygments_style = "sphinx"

html_theme = "sphinx_rtd_theme"
html_theme_options = {
"style_nav_header_background": "#C0C0C0",
"navigation_depth": -1,
"collapse_navigation": False,
"titles_only": True,
}


# html_logo = "images/xtgeo-logo.png"
html_theme = "furo"
# html_logo = "images/logo.png"

# The name of an image file (within the static path) to use as favicon
# of the docs. This file should be a Windows icon file (.ico) being
Expand Down
5 changes: 0 additions & 5 deletions docs/src/products/initial_inplace_volumes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@ This exports the initial inplace volumes of a single grid from within RMS.

- Current schema version: **{{ InplaceVolumesSchema_VERSION }}**

```{contents} Contents
:local:
:depth: 2
```

## Requirements

- RMS
Expand Down
5 changes: 3 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -67,14 +67,15 @@ dev = [
"types-PyYAML",
]
docs = [
"Sphinx",
"autoapi",
"autodoc-pydantic>=2.0.0",
"furo",
"myst-parser",
"pydocstyle",
"sphinx-autodoc-typehints<1.23",
"sphinx-rtd-theme",
"sphinx-copybutton",
"sphinx-togglebutton",
"Sphinx",
"sphinxcontrib-apidoc",
"urllib3<1.27",
]
Expand Down

0 comments on commit b75449f

Please sign in to comment.