From d84c651bb499104a2fbe8cac874302940bd604a0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Israel=20Saeta=20P=C3=A9rez?= Date: Sat, 12 Nov 2016 19:47:44 +0100 Subject: [PATCH] Add docs about how to build docs, and add sphinx as docs requirement. --- README.md | 18 ++++++++++++++++++ README.rst | 19 +++++++++++++++++++ docs/requirements.txt | 1 + 3 files changed, 38 insertions(+) diff --git a/README.md b/README.md index 94278a3..ed8b22d 100644 --- a/README.md +++ b/README.md @@ -107,3 +107,21 @@ After developing, the full test suite can be evaluated by running: ```sh 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 +``` diff --git a/README.rst b/README.rst index 976298c..1f594a9 100644 --- a/README.rst +++ b/README.rst @@ -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 +Documentation +~~~~~~~~~~~~~ + +The documentation can be generated using the excellent +`Sphinx `__ 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 .. |Build Status| image:: https://travis-ci.org/graphql-python/graphene-django.svg?branch=master :target: https://travis-ci.org/graphql-python/graphene-django diff --git a/docs/requirements.txt b/docs/requirements.txt index 5de8cc6..2548604 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,3 @@ +sphinx # Docs template https://github.com/graphql-python/graphene-python.org/archive/docs.zip