Skip to content

Commit 1e7c7ac

Browse files
authored
Merge pull request #55 from dukebody/docs-build-instructions
Add docs about how to build docs, and add sphinx as docs requirement.
2 parents dd07cb1 + d84c651 commit 1e7c7ac

File tree

3 files changed

+38
-0
lines changed

3 files changed

+38
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,3 +107,21 @@ After developing, the full test suite can be evaluated by running:
107107
```sh
108108
python setup.py test # Use --pytest-args="-v -s" for verbose mode
109109
```
110+
111+
112+
### Documentation
113+
114+
The documentation is generated using the excellent [Sphinx](http://www.sphinx-doc.org/) and a custom theme.
115+
116+
The documentation dependencies are installed by running:
117+
118+
```sh
119+
cd docs
120+
pip install -r requirements.txt
121+
```
122+
123+
Then to produce a HTML version of the documentation:
124+
125+
```sh
126+
make html
127+
```

README.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,25 @@ After developing, the full test suite can be evaluated by running:
117117
118118
python setup.py test # Use --pytest-args="-v -s" for verbose mode
119119
120+
Documentation
121+
~~~~~~~~~~~~~
122+
123+
The documentation can be generated using the excellent
124+
`Sphinx <http://www.sphinx-doc.org/>`__ and a custom theme.
125+
126+
To install the documentation dependencies, run the following:
127+
128+
.. code:: sh
129+
130+
cd docs
131+
pip install -r requirements.txt
132+
133+
Then to produce a HTML version of the documentation:
134+
135+
.. code:: sh
136+
137+
make html
138+
120139
.. |Graphene Logo| image:: http://graphene-python.org/favicon.png
121140
.. |Build Status| image:: https://travis-ci.org/graphql-python/graphene-django.svg?branch=master
122141
:target: https://travis-ci.org/graphql-python/graphene-django

docs/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
1+
sphinx
12
# Docs template
23
https://github.com/graphql-python/graphene-python.org/archive/docs.zip

0 commit comments

Comments
 (0)