Skip to content

Commit

Permalink
Merge pull request #153 from pcubillos/docs
Browse files Browse the repository at this point in the history
Fixed docs compilation
  • Loading branch information
pcubillos authored May 30, 2024
2 parents 4a58c12 + 99ba521 commit 419e299
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 3 deletions.
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

0 comments on commit 419e299

Please sign in to comment.