Sphinx DocumentationΒΆ

The simplest way to generate sphinx documentation is to use py-sphinx package from Alpine linux:


    - !Alpine v3.6
    - !Install [alpine-base, py-sphinx, make]
    # If you require additional packages to build docs uncomment this
    # - !Py3Requirements doc/requirements.txt


  doc: !Command
    description: Build documentation
    container: doc
    run: [make, html]
    work-dir: doc
    epilog: |
      Documentation is built under doc/_build/html/index.html

To start documentation from scratch (if you had no sphinx docs before), run the following once (and answer the questions):

vagga _run doc sphinx-quickstart ./doc

And add it to the git repository:

echo "/_build" >> doc/.gitignore
git add doc