Skip to content

Commit bba8377

Browse files
author
Paul Hallett
committed
Move documentation to CONTRIBUTING.md
1 parent 2ae8971 commit bba8377

File tree

3 files changed

+18
-38
lines changed

3 files changed

+18
-38
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,21 @@ After developing, the full test suite can be evaluated by running:
2929

3030
```sh
3131
make tests
32+
```
33+
34+
## Documentation
35+
36+
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.
37+
38+
The documentation dependencies are installed by running:
39+
40+
```sh
41+
cd docs
42+
pip install -r requirements.txt
43+
```
44+
45+
Then to produce a HTML version of the documentation:
46+
47+
```sh
48+
make html
3249
```

README.md

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -96,22 +96,4 @@ To learn more check out the following [examples](examples/):
9696

9797
## Contributing
9898

99-
See [CONTRIBUTING.md](contributing.md)
100-
101-
102-
### Documentation
103-
104-
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.
105-
106-
The documentation dependencies are installed by running:
107-
108-
```sh
109-
cd docs
110-
pip install -r requirements.txt
111-
```
112-
113-
Then to produce a HTML version of the documentation:
114-
115-
```sh
116-
make html
117-
```
99+
See [CONTRIBUTING.md](contributing.md)

README.rst

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -107,25 +107,6 @@ Contributing
107107

108108
See `CONTRIBUTING.md <CONTRIBUTING.md>`__.
109109

110-
Documentation
111-
~~~~~~~~~~~~~
112-
113-
The `documentation <http://docs.graphene-python.org/projects/django/en/latest/>`__ is generated using the excellent
114-
`Sphinx <http://www.sphinx-doc.org/>`__ and a custom theme.
115-
116-
The documentation dependencies are installed by running:
117-
118-
.. code:: sh
119-
120-
cd docs
121-
pip install -r requirements.txt
122-
123-
Then to produce a HTML version of the documentation:
124-
125-
.. code:: sh
126-
127-
make html
128-
129110
.. |Graphene Logo| image:: http://graphene-python.org/favicon.png
130111
.. |Build Status| image:: https://travis-ci.org/graphql-python/graphene-django.svg?branch=master
131112
:target: https://travis-ci.org/graphql-python/graphene-django

0 commit comments

Comments
 (0)