Merge pull request #930 from hickford/patch-1

Add instruction how to install Sphinx
admin-icon
Eric Holscher 2014-09-22 09:25:05 -07:00
commit 26b9a37d11
1 changed files with 8 additions and 1 deletions

View File

@ -11,7 +11,12 @@ There is `a screencast`_ that will help you get started if you prefer.
Write Your Docs
---------------
Install Sphinx_, and create a directory inside your project to hold your docs::
Sphinx_ is a tool that makes it easy to create intelligent and beautiful documentation.
Assuming you have Python_ already, `install Sphinx`_::
$ pip install sphinx
Create a directory inside your project to hold your docs::
$ cd /path/to/project
$ mkdir docs
@ -59,7 +64,9 @@ If you want to keep your code updated as you commit, configure your code reposit
If you have any more trouble, don't hesitate to reach out to us. The :doc:`support` page has more information on getting in touch.
.. _a screencast: https://www.youtube.com/watch?feature=player_embedded&v=oJsUvBQyHBs
.. _Python: https://www.python.org/
.. _Sphinx: http://sphinx-doc.org/
.. _install Sphinx: http://sphinx-doc.org/latest/install.html
.. _reStructuredText: http://sphinx-doc.org/rest.html
.. _this template: http://docs.writethedocs.org/en/latest/writing/beginners-guide-to-docs/#id1
.. _Sign up: http://readthedocs.org/accounts/signup