Merge pull request #153 from pcubillos/docs

Fixed docs compilation

Author: pcubillos

.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: .
 
+

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:

docs/docs_requirements.txt

@@ -0,0 +1,4 @@
+sphinx-rtd-theme>=2.0.0
+nbsphinx
+sphinx_copybutton
+ipython>=8.17