UPDATE (2018 Jun 6) – I’m trying to learn how to use Sphinx to create documentation from source-code docstrings. The Sphinx manual is impressively opaque. Some googling turned up this document, which seems to provide useful details.
UPDATE (2018 Jun 4) – I’ve found some new resources that are much more up-to-date:
- https://jeffknupp.com/blog/2013/08/16/open-sourcing-a-python-project-the-right-way/
- Note that this article says to run the following to set up virtualenvwrapper:
echo “source /usr/local/bin/virtualenvwrapper.sh” >> ~/.zshrcHowever, that file is not located in /usr/local/bin on my Mac (High Sierra 10.13.1). Instead, I followed the instructions here to modify the command as follows:
echo “source /Users/<username>/anaconda2/bin/virtualenvwrapper.sh” >> ~/.bash_profile
- Note that this article says to run the following to set up virtualenvwrapper:
- https://cookiecutter-pypackage.readthedocs.io/en/latest/
To set up my package so it can be installed via pip, I’m following the somewhat outdated tutorial here – https://python-packaging.readthedocs.io/en/latest/index.html.
I’ll make more notes and update this post as I go along.