readthedocs.org/contrib
Anthony 01717c03fa
Add changelog and changelog automation (#3364)
* Add changelog and changelog automation

First, update the version in our setup.cfg and changelog:

    invoke prepare <version>

Then, hand edit and commit, added any release notes, etc. Tag manually or:

    invoke release <version>

Finally, push up your changes.

This:

* Uses setup.cfg instead of setup.py
* Parses setup.cfg for version
* Updates setup.cfg on release prepare task
* Show our release version in our footer
* Uses invoke for task execution
* Uses a node library to hit GitHub and fetch the changelog
* Imports this into our existing changelog

* Fix style with autolint

* Lint fixes
2017-12-07 11:03:00 -07:00
..
changelog.hbs Add changelog and changelog automation (#3364) 2017-12-07 11:03:00 -07:00
readme.rst Update readme.rst 2017-11-29 07:45:44 -08:00
supervisord.conf Fix shitpost 2017-11-23 12:47:45 -07:00

readme.rst

Running Read the Docs via Supervisord
=====================================

This is the easiest way to start all of the commands you'll need for development
in an environment relatively close to the production evironment. All you need is
``supervisord`` and ``redis-server``. Installation of ``redis-server`` is
outside the scope of this documentation, but once installed, all you need to run
from ``supervisord`` is::

    pip install supervisor
    cd contrib/
    supervisord

This will bring up a web instance for the dashboard, a web instance for
documentation serving, two celery instances, and redis-server. 

If you already are running redis-server, this will complain about the port
already being in use, but will still load.

Debugging
---------

To debug, set trace points like normal, with ``pdb``/``ipdb``. Then you can
connect to the process by bringing it to the foreground::

    supervisorctl fg main

You'll still see logging to STDERR on the main supervisord process page.