Skip to content

Commit

Permalink
adding section on documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
opalmer committed Jan 9, 2015
1 parent 5276607 commit 40b69f6
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,22 @@ used by other parts of the PyFarm project. This package is contains:
* Miscellaneous utilities


Documentation
-------------

The documentation for this this library is hosted on
`Read The Docs <https://pyfarm.readthedocs.org/projects/pyfarm-core/en/latest/>`_.
It's generated directly from this library using sphinx (setup may vary depending
on platform)::

virtualenv env
. env/bin/activate
pip install sphinx nose
pip install -e . --egg
make -C docs html



Testing
-------

Expand Down

0 comments on commit 40b69f6

Please sign in to comment.