Skip to content

Commit

Permalink
Fix ReadTheDocs builds (#1509)
Browse files Browse the repository at this point in the history
* Add RTD config file

* Doc fixes to reference main branch instead of master
  • Loading branch information
PabloAlexis611 authored Mar 29, 2024
1 parent 45c2aa0 commit 3f813d4
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 7 deletions.
18 changes: 18 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ make tests

## 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.

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Graphene-Django is an open-source library that provides seamless integration bet

To install Graphene-Django, run the following command:

```
```sh
pip install graphene-django
```

Expand Down Expand Up @@ -114,11 +114,11 @@ class MyModelAPITestCase(GraphQLTestCase):

## 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

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

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial-plain.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Load some test data

Now is a good time to load up some test data. The easiest option will be
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
``cookbook/ingredients/fixtures/ingredients.json``. You can then run the
following:
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorial-relay.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Graphene has a number of additional features that are designed to make
working with Django *really simple*.

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:

Expand Down Expand Up @@ -87,7 +87,7 @@ Load some test data

Now is a good time to load up some test data. The easiest option will be
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
``cookbook/ingredients/fixtures/ingredients.json``. You can then run the
following:
Expand Down

0 comments on commit 3f813d4

Please sign in to comment.