Skip to content

Commit d95163c

Browse files
morenoh149mvanlonden
authored andcommitted
Add Docs link to readme (#914)
* change header of contributing docs to building docs
1 parent 9ae2359 commit d95163c

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,11 @@ If you want to learn even more, you can also check the following [examples](exam
136136
- **Basic Schema**: [Starwars example](examples/starwars)
137137
- **Relay Schema**: [Starwars Relay example](examples/starwars_relay)
138138

139+
## Documentation
140+
141+
Documentation and links to additional resources are available at
142+
https://docs.graphene-python.org/en/latest/
143+
139144
## Contributing
140145

141146
After cloning this repo, create a [virtualenv](https://virtualenv.pypa.io/en/stable/) and ensure dependencies are installed by running:
@@ -177,7 +182,7 @@ tox -e py36
177182

178183
Tox can only use whatever versions of python are installed on your system. When you create a pull request, Travis will also be running the same tests and report the results, so there is no need for potential contributors to try to install every single version of python on their own system ahead of time. We appreciate opening issues and pull requests to make graphene even more stable & useful!
179184

180-
### Documentation
185+
### Building Documentation
181186

182187
The documentation is generated using the excellent [Sphinx](http://www.sphinx-doc.org/) and a custom theme.
183188

README.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,12 @@ If you want to learn even more, you can also check the following
267267
- **Relay Schema**: `Starwars Relay
268268
example <examples/starwars_relay>`__
269269

270+
Documentation
271+
-------------
272+
273+
Documentation and links to additional resources are available at
274+
https://docs.graphene-python.org/en/latest/
275+
270276
Contributing
271277
------------
272278

@@ -324,7 +330,7 @@ contributors to try to install every single version of python on their
324330
own system ahead of time. We appreciate opening issues and pull requests
325331
to make graphene even more stable & useful!
326332

327-
Documentation
333+
Building Documentation
328334
~~~~~~~~~~~~~
329335

330336
The documentation is generated using the excellent

0 commit comments

Comments
 (0)