readthedocs.org/contrib
Eric Holscher cb7f865863
Merge pull request #4370 from jaraco/feature/2725-add-project-script
Script for creating a project
2018-10-31 09:27:17 -05:00
..
add-project.py Add script that will configure a GitHub checkout for RTD. Fixes #2725. 2018-07-16 18:18:56 -04:00
changelog.hbs #3718: Added date to changelog (#3788) 2018-03-29 10:23:58 -06:00
readme.rst Update readme.rst 2017-11-29 07:45:44 -08:00
supervisord.conf Ability to use supervisor from python 2.7 and still run Python 3 (#4606) 2018-09-06 08:23:38 -06: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.