graphql-python/graphene-django
1
1
Fork 0
mirror of https://github.com/graphql-python/graphene-django.git synced 2024-11-10 19:57:15 +03:00
Code Issues Packages Projects Releases Wiki Activity

Move documentation to CONTRIBUTING.md

Browse Source
This commit is contained in:
Paul Hallett 2019-04-26 14:08:44 +01:00
parent 2ae897187c
commit bba8377a82
No known key found for this signature in database
GPG Key ID: 529C11F0C93CDF11
3 changed files with 18 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.md
View File

@ -29,4 +29,21 @@ After developing, the full test suite can be evaluated by running:
```sh
make tests
```
## Documentation
The [documentation](http://docs.graphene-python.org/projects/django/en/latest/) 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
```

20
README.md
View File

@ -96,22 +96,4 @@ To learn more check out the following [examples](examples/):
## Contributing
See [CONTRIBUTING.md](contributing.md)
### Documentation
The [documentation](http://docs.graphene-python.org/projects/django/en/latest/) 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
```
See [CONTRIBUTING.md](contributing.md)

19
README.rst
View File

@ -107,25 +107,6 @@ Contributing
See `CONTRIBUTING.md <CONTRIBUTING.md>`__.
Documentation
~~~~~~~~~~~~~
The `documentation <http://docs.graphene-python.org/projects/django/en/latest/>`__ is generated using the excellent
`Sphinx <http://www.sphinx-doc.org/>`__ and a custom theme.
The documentation dependencies are installed by running:
.. 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