Merge branch 'public' of github.com:libAtoms/QUIP into public

libAtoms · Oct 11, 2022 · 8ac2933 · 8ac2933
2 parents 49cff8d + d0c1885
commit 8ac2933
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 16 deletions.
diff --git a/.github/workflows/Build.yml b/.github/workflows/Build.yml
@@ -123,8 +123,12 @@ jobs:
       - name: Build documentation
         run: |
           sudo apt-get install -y libgsl0-dev libxpm-dev pandoc
-          pip install sphinx sphinx-rtd-theme nbsphinx numpydoc pygments==2.5.2
-          pip install nbconvert[execute] ipython
+          pip install sphinx sphinx-rtd-theme nbsphinx numpydoc pygments==2.5.2 nbconvert[execute] ipython
+
+          # FIXME: currently we use the released version of quippy package to build docs, 
+          # would be better to cache wheel from step above
+          pip install quippy-ase
+
           cd doc
           python -m sphinx . _build/html
 

diff --git a/doc/Tutorials/CCP5-June-2021.ipynb b/doc/Tutorials/CCP5-June-2021.ipynb
@@ -204,11 +204,11 @@
    "source": [
     "# Code Availability\n",
     "\n",
-    "### License\n",
+    "## License\n",
     "\n",
     "Most of QUIP is licensed under the GPLv2, with some code in the public domain. Submodules have different licences, e.g. GAP has a non-commerical [academic software license](https://github.com/libAtoms/GAP/blob/main/LICENSE.md).\n",
     "\n",
-    "### Building from source\n",
+    "## Building from source\n",
     "\n",
     "Quick start:\n",
     "```\n",
@@ -1026,7 +1026,7 @@
  "metadata": {
   "celltoolbar": "Slideshow",
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -1040,7 +1040,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.5"
+   "version": "3.10.7"
   }
  },
  "nbformat": 4,

diff --git a/doc/Tutorials/overview.rst b/doc/Tutorials/overview.rst
@@ -1,7 +1,6 @@
-QUIP Overview Tutorial
-======================
+QUIP Overview Tutorials
+=======================
 
 .. toctree::
-    :maxdepth: 2
+    CCP5-June-2021
 
-    CCP5-June-2021.ipynb
diff --git a/doc/conf.py b/doc/conf.py
@@ -77,7 +77,7 @@
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = ['.rst', '.ipynb']
+source_suffix = ['.rst']
 
 # The master toctree document.
 master_doc = 'index'
@@ -104,7 +104,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'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

diff --git a/doc/install.rst b/doc/install.rst
@@ -21,10 +21,7 @@
 Installation of QUIP and quippy
 *******************************
 
-For installation instructions, please see the
-`installation instructions <https://libatoms.github.io/GAP/installation.html>`_
-provided with the ``GAP`` code, or the
-`top-level README <https://github.com/libAtoms/QUIP/blob/public/README.md>`_
+For installation instructions see the `top-level README <https://github.com/libAtoms/QUIP/blob/public/README.md>`_
 for QUIP.