From 3f813d467996f3bb3ad1f81d0a6648b7d41c9328 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pablo=20Alexis=20Dom=C3=ADnguez=20Grau?= Date: Fri, 29 Mar 2024 00:11:56 -0400 Subject: [PATCH] Fix ReadTheDocs builds (#1509) * Add RTD config file * Doc fixes to reference main branch instead of master --- .readthedocs.yaml | 18 ++++++++++++++++++ CONTRIBUTING.md | 2 +- README.md | 6 +++--- docs/tutorial-plain.rst | 2 +- docs/tutorial-relay.rst | 4 ++-- 5 files changed, 25 insertions(+), 7 deletions(-) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..3682573 --- /dev/null +++ b/.readthedocs.yaml @@ -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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6a226ab..ec4f2bd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md index 2e3531f..686f5ec 100644 --- a/README.md +++ b/README.md @@ -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 ``` @@ -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 diff --git a/docs/tutorial-plain.rst b/docs/tutorial-plain.rst index 9073c82..12237df 100644 --- a/docs/tutorial-plain.rst +++ b/docs/tutorial-plain.rst @@ -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 `__ +ingredients.json `__ fixture and place it in ``cookbook/ingredients/fixtures/ingredients.json``. You can then run the following: diff --git a/docs/tutorial-relay.rst b/docs/tutorial-relay.rst index bf93299..8ea69da 100644 --- a/docs/tutorial-relay.rst +++ b/docs/tutorial-relay.rst @@ -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 `__. +app `__. 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 to `download the -ingredients.json `__ +ingredients.json `__ fixture and place it in ``cookbook/ingredients/fixtures/ingredients.json``. You can then run the following: