-
Notifications
You must be signed in to change notification settings - Fork 194
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add draft docs for building the docs
- Loading branch information
Showing
3 changed files
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,3 +15,4 @@ It's used by the | |
|
||
publishers/index | ||
developers/index | ||
documenters/index |