Skip to content

Commit 3f813d4

Browse files
Fix ReadTheDocs builds (#1509)
* Add RTD config file * Doc fixes to reference main branch instead of master
1 parent 45c2aa0 commit 3f813d4

File tree

5 files changed

+25
-7
lines changed

5 files changed

+25
-7
lines changed

.readthedocs.yaml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
version: 2
6+
build:
7+
os: ubuntu-22.04
8+
tools:
9+
python: "3.12"
10+
11+
# Build documentation in the "docs/" directory with Sphinx
12+
sphinx:
13+
configuration: docs/conf.py
14+
15+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
16+
python:
17+
install:
18+
- requirements: docs/requirements.txt

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ make tests
3333

3434
## Opening Pull Requests
3535

36-
Please fork the project and open a pull request against the master branch.
36+
Please fork the project and open a pull request against the `main` branch.
3737

3838
This will trigger a series of test and lint checks.
3939

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Graphene-Django is an open-source library that provides seamless integration bet
3030

3131
To install Graphene-Django, run the following command:
3232

33-
```
33+
```sh
3434
pip install graphene-django
3535
```
3636

@@ -114,11 +114,11 @@ class MyModelAPITestCase(GraphQLTestCase):
114114

115115
## Contributing
116116

117-
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).
117+
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).
118118

119119
## License
120120

121-
Graphene-Django is released under the [MIT License](https://github.com/graphql-python/graphene-django/blob/master/LICENSE).
121+
Graphene-Django is released under the [MIT License](https://github.com/graphql-python/graphene-django/blob/main/LICENSE).
122122

123123
## Resources
124124

docs/tutorial-plain.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Load some test data
104104

105105
Now is a good time to load up some test data. The easiest option will be
106106
to `download the
107-
ingredients.json <https://raw.githubusercontent.com/graphql-python/graphene-django/master/examples/cookbook/cookbook/ingredients/fixtures/ingredients.json>`__
107+
ingredients.json <https://raw.githubusercontent.com/graphql-python/graphene-django/main/examples/cookbook/cookbook/ingredients/fixtures/ingredients.json>`__
108108
fixture and place it in
109109
``cookbook/ingredients/fixtures/ingredients.json``. You can then run the
110110
following:

docs/tutorial-relay.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Graphene has a number of additional features that are designed to make
77
working with Django *really simple*.
88

99
Note: The code in this quickstart is pulled from the `cookbook example
10-
app <https://github.com/graphql-python/graphene-django/tree/master/examples/cookbook>`__.
10+
app <https://github.com/graphql-python/graphene-django/tree/main/examples/cookbook>`__.
1111

1212
A good idea is to check the following things first:
1313

@@ -87,7 +87,7 @@ Load some test data
8787

8888
Now is a good time to load up some test data. The easiest option will be
8989
to `download the
90-
ingredients.json <https://raw.githubusercontent.com/graphql-python/graphene-django/master/examples/cookbook/cookbook/ingredients/fixtures/ingredients.json>`__
90+
ingredients.json <https://raw.githubusercontent.com/graphql-python/graphene-django/main/examples/cookbook/cookbook/ingredients/fixtures/ingredients.json>`__
9191
fixture and place it in
9292
``cookbook/ingredients/fixtures/ingredients.json``. You can then run the
9393
following:

0 commit comments

Comments
 (0)