Skip to content

Commit

Permalink
Merge pull request #92 from Chilipp/fix-docs
Browse files Browse the repository at this point in the history
fix docs
  • Loading branch information
Chilipp committed Dec 28, 2023
2 parents a7fea62 + 246780b commit eca0cd3
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 9 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Expand Up @@ -63,4 +63,5 @@ target/
# Example ipython notebook checkpoints
*.ipynb_checkpoints/

.mypy_cache
.mypy_cache
venv/
8 changes: 7 additions & 1 deletion .readthedocs.yml
@@ -1,10 +1,16 @@
version: 2

# Set the OS, Python version and other tools you might need

build:
os: ubuntu-22.04
tools:
python: "3.11"

sphinx:
configuration: docs/conf.py

python:
version: 3.8
install:
- method: pip
path: .
Expand Down
7 changes: 1 addition & 6 deletions docs/conf.py
Expand Up @@ -16,7 +16,6 @@
import os
import os.path as osp
import re
import six
import autodocsumm

# If extensions (or modules to document with autodoc) are in another directory,
Expand Down Expand Up @@ -131,11 +130,7 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.

if not on_rtd: # only import and set the theme if we're building docs locally
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_theme = 'sphinx_rtd_theme'

# otherwise, readthedocs.org uses their theme by default, so no need to specify

Expand Down
3 changes: 2 additions & 1 deletion docs/requirements.txt
@@ -1 +1,2 @@
Sphinx<7
Sphinx
sphinx-rtd-theme

0 comments on commit eca0cd3

Please sign in to comment.