From 99ba5218701566c25e38c004b6db83e420a7fb2d Mon Sep 17 00:00:00 2001 From: Patricio Cubillos Date: Thu, 30 May 2024 17:20:46 +0200 Subject: [PATCH] Fixed docs compilation --- .readthedocs.yml | 12 ++++++++++-- docs/conf.py | 5 ++++- docs/docs_requirements.txt | 4 ++++ 3 files changed, 18 insertions(+), 3 deletions(-) create mode 100644 docs/docs_requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml index 8680284..89996ac 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -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: . + diff --git a/docs/conf.py b/docs/conf.py index a5ffda6..a7e1d28 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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. @@ -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: diff --git a/docs/docs_requirements.txt b/docs/docs_requirements.txt new file mode 100644 index 0000000..66b07d7 --- /dev/null +++ b/docs/docs_requirements.txt @@ -0,0 +1,4 @@ +sphinx-rtd-theme>=2.0.0 +nbsphinx +sphinx_copybutton +ipython>=8.17