This is the third occasion that I’ve come to set up a Python package’s documentation. It is also the third occasion where I’ve spent many hours and commits trying to work out how I made everything work last time. So for my future sanity and possibly yours, here’s a quick guide on setting up Sphinx-based, ReadTheDocs-hosted Python documentation.
autodoc, config, docstring, documentation, napoleon, numpy, py-modindex, python, readthedocs, sphinx, sphinx-autodoc, sphinx-napoleon, theme
Today, whilst continuing development on Goldilocks, I discovered a minor oddity that left me a little confused and bemused before lunch: True did not appear to be True… Part of Goldilocks‘ functionality allows for the filtering of results; users may specify a dictionary of criteria whose keys map to functions to be applied to result […]