mirror of
https://github.com/graphql-python/graphene-django.git
synced 2025-02-07 15:10:35 +03:00
Move documentation to CONTRIBUTING.md
This commit is contained in:
parent
2ae897187c
commit
bba8377a82
|
@ -30,3 +30,20 @@ After developing, the full test suite can be evaluated by running:
|
||||||
```sh
|
```sh
|
||||||
make tests
|
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
|
||||||
|
```
|
18
README.md
18
README.md
|
@ -97,21 +97,3 @@ To learn more check out the following [examples](examples/):
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
See [CONTRIBUTING.md](contributing.md)
|
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
|
|
||||||
```
|
|
||||||
|
|
19
README.rst
19
README.rst
|
@ -107,25 +107,6 @@ Contributing
|
||||||
|
|
||||||
See `CONTRIBUTING.md <CONTRIBUTING.md>`__.
|
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
|
.. |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
|
||||||
|
|
Loading…
Reference in New Issue
Block a user