Maintenance

Documentation on maintaining my open-source projects. Most of this will probably cover Python packaging.

Building

Run Sphinx on the documentation:

tox -e build

Open the index using your browser:

tox -e open

Rebuild the documenation when files are changed (requires watch-fs):

watch-fs -d docs 'tox -e build'

Style

Use code blocks marked with the language where possible:

.. code-block:: bash

    function error() { exit 1; }

Licence

This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.

Author

Written and maintained by Sam Clements.