Skip to content

Commit

Permalink
Use pydata-sphinx-theme for API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderFabisch committed Sep 10, 2024
1 parent 2ad478d commit 5b98a6d
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 14 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -492,3 +492,8 @@ Bremen. At this phase the work was supported through a grant of the German
Federal Ministry of Economic Affairs and Energy (BMWi, FKZ 50 RA 1701).

<img src="https://raw.githubusercontent.com/dfki-ric/movement_primitives/main/doc/source/_static/DFKI_Logo.jpg" height="150px" /><img src="https://raw.githubusercontent.com/dfki-ric/movement_primitives/main/doc/source/_static/241-logo-bmwi-jpg.jpg" height="150px" />

```{toctree}
:hidden:
api
```
17 changes: 5 additions & 12 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
import os
import sys
import time
import sphinx_bootstrap_theme


sys.path.insert(0, os.path.abspath('.'))
Expand Down Expand Up @@ -58,18 +57,12 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "bootstrap"
html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
html_theme = "pydata_sphinx_theme"
html_theme_options = {
"bootswatch_theme": "readable",
"navbar_sidebarrel": False,
"bootstrap_version": "3",
"nosidebar": True,
"body_max_width": "90%",
"navbar_links": [
("Home", "index"),
("API", "api"),
],
"logo": {
"text": f"movement_primitives {release}"
},
"navbar_start": ["navbar-logo"],
}

root_doc = "index"
Expand Down
3 changes: 1 addition & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@
extras_require={
"all": ["pytransform3d", "cython", "numpy", "scipy", "matplotlib",
"open3d", "tqdm", "gmr", "PyYAML", "numba", "pybullet"],
"doc": ["sphinx", "sphinx-bootstrap-theme", "numpydoc",
"myst-parser"],
"doc": ["sphinx", "pydata-sphinx-theme", "numpydoc", "myst-parser"],
"test": ["pytest", "pytest-cov"]
}
)
Expand Down

0 comments on commit 5b98a6d

Please sign in to comment.