Skip to content

Commit

Permalink
Add draft docs for building the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
seanh committed Mar 10, 2017
1 parent f9909a3 commit bd33075
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/documenters/buildthedocs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Building the Docs Locally
=========================

You will need:

#. Git
#. Python and Virtualenv
#. Make

To build the docs:

#. ``git clone https://github.com/hypothesis/client.git``
#. ``cd client``
#. Create and activate a Python virtual environment.
#. ``pip install -r requirements-dev.in``
#. ``make docs``

Now open http://localhost:8888 to view your local build of the docs.
The built docs will automatically update when you save changes to the source
files.
10 changes: 10 additions & 0 deletions docs/documenters/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
For Documenters
===============

This section contains documentation for **documenters** who want to contribute
documentation to the Hypothesis client.

.. toctree::
:maxdepth: 3

buildthedocs
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ It's used by the

publishers/index
developers/index
documenters/index

0 comments on commit bd33075

Please sign in to comment.