mirror of
https://github.com/graphql-python/graphene-django.git
synced 2024-11-24 18:44:08 +03:00
Fix ReadTheDocs builds (#1509)
* Add RTD config file * Doc fixes to reference main branch instead of master
This commit is contained in:
parent
45c2aa09b5
commit
3f813d4679
18
.readthedocs.yaml
Normal file
18
.readthedocs.yaml
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
# .readthedocs.yaml
|
||||||
|
# Read the Docs configuration file
|
||||||
|
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
||||||
|
|
||||||
|
version: 2
|
||||||
|
build:
|
||||||
|
os: ubuntu-22.04
|
||||||
|
tools:
|
||||||
|
python: "3.12"
|
||||||
|
|
||||||
|
# Build documentation in the "docs/" directory with Sphinx
|
||||||
|
sphinx:
|
||||||
|
configuration: docs/conf.py
|
||||||
|
|
||||||
|
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
|
||||||
|
python:
|
||||||
|
install:
|
||||||
|
- requirements: docs/requirements.txt
|
|
@ -33,7 +33,7 @@ make tests
|
||||||
|
|
||||||
## Opening Pull Requests
|
## Opening Pull Requests
|
||||||
|
|
||||||
Please fork the project and open a pull request against the master branch.
|
Please fork the project and open a pull request against the `main` branch.
|
||||||
|
|
||||||
This will trigger a series of test and lint checks.
|
This will trigger a series of test and lint checks.
|
||||||
|
|
||||||
|
|
|
@ -30,7 +30,7 @@ Graphene-Django is an open-source library that provides seamless integration bet
|
||||||
|
|
||||||
To install Graphene-Django, run the following command:
|
To install Graphene-Django, run the following command:
|
||||||
|
|
||||||
```
|
```sh
|
||||||
pip install graphene-django
|
pip install graphene-django
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -114,11 +114,11 @@ class MyModelAPITestCase(GraphQLTestCase):
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Contributions to Graphene-Django are always welcome! To get started, check the repository's [issue tracker](https://github.com/graphql-python/graphene-django/issues) and [contribution guidelines](https://github.com/graphql-python/graphene-django/blob/master/CONTRIBUTING.md).
|
Contributions to Graphene-Django are always welcome! To get started, check the repository's [issue tracker](https://github.com/graphql-python/graphene-django/issues) and [contribution guidelines](https://github.com/graphql-python/graphene-django/blob/main/CONTRIBUTING.md).
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Graphene-Django is released under the [MIT License](https://github.com/graphql-python/graphene-django/blob/master/LICENSE).
|
Graphene-Django is released under the [MIT License](https://github.com/graphql-python/graphene-django/blob/main/LICENSE).
|
||||||
|
|
||||||
## Resources
|
## Resources
|
||||||
|
|
||||||
|
|
|
@ -104,7 +104,7 @@ Load some test data
|
||||||
|
|
||||||
Now is a good time to load up some test data. The easiest option will be
|
Now is a good time to load up some test data. The easiest option will be
|
||||||
to `download the
|
to `download the
|
||||||
ingredients.json <https://raw.githubusercontent.com/graphql-python/graphene-django/master/examples/cookbook/cookbook/ingredients/fixtures/ingredients.json>`__
|
ingredients.json <https://raw.githubusercontent.com/graphql-python/graphene-django/main/examples/cookbook/cookbook/ingredients/fixtures/ingredients.json>`__
|
||||||
fixture and place it in
|
fixture and place it in
|
||||||
``cookbook/ingredients/fixtures/ingredients.json``. You can then run the
|
``cookbook/ingredients/fixtures/ingredients.json``. You can then run the
|
||||||
following:
|
following:
|
||||||
|
|
|
@ -7,7 +7,7 @@ Graphene has a number of additional features that are designed to make
|
||||||
working with Django *really simple*.
|
working with Django *really simple*.
|
||||||
|
|
||||||
Note: The code in this quickstart is pulled from the `cookbook example
|
Note: The code in this quickstart is pulled from the `cookbook example
|
||||||
app <https://github.com/graphql-python/graphene-django/tree/master/examples/cookbook>`__.
|
app <https://github.com/graphql-python/graphene-django/tree/main/examples/cookbook>`__.
|
||||||
|
|
||||||
A good idea is to check the following things first:
|
A good idea is to check the following things first:
|
||||||
|
|
||||||
|
@ -87,7 +87,7 @@ Load some test data
|
||||||
|
|
||||||
Now is a good time to load up some test data. The easiest option will be
|
Now is a good time to load up some test data. The easiest option will be
|
||||||
to `download the
|
to `download the
|
||||||
ingredients.json <https://raw.githubusercontent.com/graphql-python/graphene-django/master/examples/cookbook/cookbook/ingredients/fixtures/ingredients.json>`__
|
ingredients.json <https://raw.githubusercontent.com/graphql-python/graphene-django/main/examples/cookbook/cookbook/ingredients/fixtures/ingredients.json>`__
|
||||||
fixture and place it in
|
fixture and place it in
|
||||||
``cookbook/ingredients/fixtures/ingredients.json``. You can then run the
|
``cookbook/ingredients/fixtures/ingredients.json``. You can then run the
|
||||||
following:
|
following:
|
||||||
|
|
Loading…
Reference in New Issue
Block a user