Skip to content
Snippets Groups Projects
  • Remco de Boer's avatar
    docs!: import Pawian wiki pages · 285b3f1f
    Remco de Boer authored
    Imports the pages hosted at
      https://panda-wiki.gsi.de/foswiki/bin/view/PWA/PawianPwaSoftware
    into Sphinx (reStructuredText)
      https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
    
    This has a few advantages:
    * The documentation is now put under source control and is automatically
      linked (commit-by-commit) to the source code
    * Sphinx allows one to make links to related documentation (intersphinx)
      and to the internals of the source code (API)
    * We can implement several CI checks via Sphinx, such as link checking,
      running Jupyter notebooks, and rendering them in the documentation.
      Note that the documentation is already built and tested automatically
      through .gitlab-ci.yml
    
    The documentation can be built by installing the developer tools:
      python3 -m pip install .[dev]
    and running either
      tox -e doc
    or running
      make html
    from the doc directory
    Verified
    285b3f1f