Add documentation build

.gitlab-ci.yml

@@ -6,6 +6,7 @@ variables:
 stages:
   - build_docker
   - testing
+  - release
 
 build_docker_from_scratch:
   only:
@@ -31,10 +32,12 @@ build_docker_from_cache:
     - docker build -t $CONTAINER_TEST_IMAGE .
     - docker push $CONTAINER_TEST_IMAGE
 
+before_script:
+  - pip3 install --user .
+
 mytest:
   stage: testing
   script:
-    - pip3 install .
     - pytest-3 -q --cov=resolve test
   coverage: '/^TOTAL.+?(\d+\%)$/'
 
@@ -43,10 +46,17 @@ test_mpi:
   variables:
     OMPI_MCA_btl_vader_single_copy_mechanism: none
   script:
-    - pip3 install .
     - mpiexec -n 2 --bind-to none pytest-3 -q test/test_mpi
 
-# staticchecks:
-#   stage: testing
-#   script:
-#     - flake8 .
+pages:
+  stage: release
+  script:
+    - rm -rf docs/build docs/source/mod
+    - sh docs/generate.sh
+    - mv docs/build public
+  artifacts:
+    paths:
+      - public
+#  only:
+#    - master
+

Dockerfile

@@ -13,7 +13,8 @@ RUN pip3 install astropy
 RUN apt-get install -qq python3-mpi4py
 # Testing dependencies
 RUN apt-get install -qq python3-pytest-cov
-RUN pip3 install flake8
+# Documentation dependencies
+RUN apt-get install -qq python3-sphinx-rtd-theme
 
 # Create user (openmpi does not like to be run as root)
 RUN useradd -ms /bin/bash testinguser

docs/generate.sh

+sphinx-apidoc -e -o docs/source/mod resolve
+sphinx-build -b html docs/source/ docs/build/

docs/source/conf.py

+extensions = [
+    'sphinx.ext.napoleon',  # Support for NumPy and Google style docstrings
+    'sphinx.ext.imgmath',  # Render math as images
+    'sphinx.ext.viewcode'  # Add links to highlighted source code
+]
+master_doc = 'index'
+
+napoleon_google_docstring = False
+napoleon_numpy_docstring = True
+napoleon_use_ivar = True
+napoleon_use_admonition_for_notes = True
+napoleon_use_admonition_for_examples = True
+napoleon_use_admonition_for_references = True
+napoleon_include_special_with_doc = True
+
+project = u'resolve'
+copyright = u'2019-2021, Max-Planck-Society'
+author = u'Philipp Arras'
+
+# FIXME release = resolve.version.__version__
+# FIXME version = release[:-2]
+
+language = None
+exclude_patterns = []
+add_module_names = False
+
+html_theme = "sphinx_rtd_theme"

docs/source/index.rst

+Resolve
+=======
+
+Resolve is a Bayesian radio imaging algorithm.
+
+References
+----------
+
+FIXME
+
+Contents
+........
+
+.. toctree::
+   :maxdepth: 2
+
+   Package Documentation <mod/resolve>