Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed docs compilation #153

Merged
merged 1 commit into from
May 30, 2024
Merged
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: 10 additions & 2 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
version: 2

formats: []
build:
os: "ubuntu-22.04"
tools:
python: "3.11"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

python:
version: 3.8
install:
- requirements: requirements.txt
- requirements: docs/docs_requirements.txt
- method: pip
path: .


5 changes: 4 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@
'sphinx.ext.autodoc',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'IPython.sphinxext.ipython_console_highlighting',
'nbsphinx',
"sphinx_copybutton",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -72,7 +75,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = 'en'

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
Expand Down
4 changes: 4 additions & 0 deletions docs/docs_requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
sphinx-rtd-theme>=2.0.0
nbsphinx
sphinx_copybutton
ipython>=8.17