Merge pull request #55 from dukebody/docs-build-instructions

Add docs about how to build docs, and add sphinx as docs requirement.
This commit is contained in:
Syrus Akbary 2016-11-13 19:21:02 -08:00 committed by GitHub
commit 1e7c7ac34f
3 changed files with 38 additions and 0 deletions

View File

@ -107,3 +107,21 @@ After developing, the full test suite can be evaluated by running:
```sh ```sh
python setup.py test # Use --pytest-args="-v -s" for verbose mode python setup.py test # Use --pytest-args="-v -s" for verbose mode
``` ```
### Documentation
The documentation is generated using the excellent [Sphinx](http://www.sphinx-doc.org/) and a custom theme.
The documentation dependencies are installed by running:
```sh
cd docs
pip install -r requirements.txt
```
Then to produce a HTML version of the documentation:
```sh
make html
```

View File

@ -117,6 +117,25 @@ After developing, the full test suite can be evaluated by running:
python setup.py test # Use --pytest-args="-v -s" for verbose mode python setup.py test # Use --pytest-args="-v -s" for verbose mode
Documentation
~~~~~~~~~~~~~
The documentation can be generated using the excellent
`Sphinx <http://www.sphinx-doc.org/>`__ and a custom theme.
To install the documentation dependencies, run the following:
.. code:: sh
cd docs
pip install -r requirements.txt
Then to produce a HTML version of the documentation:
.. code:: sh
make html
.. |Graphene Logo| image:: http://graphene-python.org/favicon.png .. |Graphene Logo| image:: http://graphene-python.org/favicon.png
.. |Build Status| image:: https://travis-ci.org/graphql-python/graphene-django.svg?branch=master .. |Build Status| image:: https://travis-ci.org/graphql-python/graphene-django.svg?branch=master
:target: https://travis-ci.org/graphql-python/graphene-django :target: https://travis-ci.org/graphql-python/graphene-django

View File

@ -1,2 +1,3 @@
sphinx
# Docs template # Docs template
https://github.com/graphql-python/graphene-python.org/archive/docs.zip https://github.com/graphql-python/graphene-python.org/archive/docs.zip