Merge pull request #5 from antoinedemathelin/master

docs: Update documentation

Author: antoinedemathelin

.github/workflows/check-docs.yml

@@ -18,7 +18,7 @@ jobs:
       run: |
         sudo apt install pandoc
         python -m pip install --upgrade pip
-        pip install sphinx numpydoc nbsphinx sphinx_gallery sphinx_rtd_theme
+        pip install sphinx numpydoc nbsphinx sphinx_gallery sphinx_rtd_theme ipython
     - name: Install adapt dependencies
       run: |
         python -m pip install --upgrade pip
@@ -31,6 +31,8 @@ jobs:
         sudo rm -r -f docs/*
         make html
         sudo rm -r -f docs/doctrees
+        sudo rm -r -f docs/html/_sources
+        sudo rm -r -f docs/html/examples/*.ipynb
         mv -v docs/html/* docs/
         sudo rm -r -f docs/html
         touch .nojekyll

.github/workflows/publish-doc-to-remote.yml

@@ -17,7 +17,7 @@ jobs:
       run: |
         sudo apt install pandoc
         python -m pip install --upgrade pip
-        pip install sphinx numpydoc nbsphinx sphinx_gallery sphinx_rtd_theme
+        pip install sphinx numpydoc nbsphinx sphinx_gallery sphinx_rtd_theme ipython
     - name: Install adapt dependencies
       run: |
         python -m pip install --upgrade pip
@@ -30,6 +30,8 @@ jobs:
         sudo rm -r -f docs/*
         make html
         sudo rm -r -f docs/doctrees
+        sudo rm -r -f docs/html/_sources
+        sudo rm -r -f docs/html/examples/*.ipynb
         mv -v docs/html/* docs/
         sudo rm -r -f docs/html
         touch .nojekyll

src_docs/_static/images/multifidelity_high.gif

@@ -31,7 +31,8 @@
  'numpydoc',
  'sphinx.ext.linkcode',
  'nbsphinx',
- 'sphinx_gallery.load_style'
+ 'sphinx_gallery.load_style',
+ 'IPython.sphinxext.ipython_console_highlighting'
  ]
 
 numpydoc_show_inherited_class_members = False
@@ -83,6 +84,8 @@
     'js/custom.js',
 ]
 
+html_show_sourcelink = False
+
 
 #sphinx_gallery_conf = {
 #    'reference_url': {"adapt": None},