From 617672ce68a24c4397ae009a69b4d93850e4b8b6 Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Wed, 4 Dec 2019 12:37:45 +0100 Subject: [PATCH 1/5] Update README.rst --- README.rst | 70 +++--------------------------------------------------- 1 file changed, 3 insertions(+), 67 deletions(-) diff --git a/README.rst b/README.rst index 0c6ca47..56abbfc 100644 --- a/README.rst +++ b/README.rst @@ -1,68 +1,4 @@ -Test Builds -=========== +New Pull Request +============== -This repository is used internally to create different scenarios -on build configs and trigger many builds on Read the Docs productions. - -Each branch should explain on it's ``docs/index.rst`` what's about and how the -QA process can be considered a success or a failure. - -If we need to test a very specific use case, we create a new branch with -the issue number and the repository, like: ``issue-1234-org``, ``issue-4321-ext`` or similar. - - -Scenarios ---------- - -Each of these scenarios is a branch that can be built independenly from the others. - -* `alabaster-theme `_: use ``alabaster`` as theme -* `auto-wipe `_: used for auto wipe the environment when a config is changed -* `branch/with/slashes `_: used to check that git clones without problem -* `conda-env `_: use a simple conda environment to build the docs -* `conda-env-py3.7 `_: use a simple conda environment to build the docs with Python 3.7 -* `datetime `_: shows different times (system time, build time, etc) -* `environment-variables `_: shows all the environment variables used to build the docs -* `huge-build-output `_: generate megabytes of output data for commands -* `none-formats `_: use ``formats: []`` so only HTML is built -* `requirements-not-found `_: use ``requirements_file: .notfound.txt`` -* `robots-txt `_: use a custom ``robots.txt`` for this project -* `search-with-old-sphinx-and-theme `_: search box on old Sphinx and RTD theme version -* `timeout `_: generate a timeout by sleeping 1000 seconds -* `typlog-theme `_: use ``typlog`` as theme -* `ŭñíč°də-branch `_: the name of the branch is unicode -* `unicode-filename `_: has a page (rst) that its filename is unicode -* `use-py2 `_: use ``python: version: 2`` -* `yaml-v2 `_: use a simple YAML for the V2 configuration - - -.. note:: - - There could be more scenarios probably, but this list is not always up to date. - Please, check `all the branches `_ to be sure. - -Tags ----- - -We also have some tags to have some tests around this. - -* `tag-v1 `_: points to an specific commit -* `tag-v2 `_: points to the same commit than ``tag-v1`` (`Delete tags with same commit `_) - - -Addind a new scenario to the repository ---------------------------------------- - -#. Create a new branch from ``master`` using an appropiate name -#. Explain what's the use case in its ``docs/index.rst`` file - - * How to check if the QA can be considered success or failure - * Add links to the issue tracker where there are more information -#. Add or modify the necessary files - - * Make sure that these files contains the minimum configuration needed: - - * remove auto generated comments - * configs not used -#. Push your changes -#. Modify the ``README.rst`` file from ``master`` to add this new branch in the list +Testing 3, 2, 1... From 77bbca8bc48f2795607ecbf8a30ac3907a19f6bd Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Thu, 31 Aug 2023 11:57:20 +0200 Subject: [PATCH 2/5] Update config --- .readthedocs.yaml | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e124d1d..7a9d09d 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -3,13 +3,7 @@ version: 2 build: os: ubuntu-22.04 tools: - python: "3" - apt_packages: - - tree - -sphinx: - configuration: docs/conf.py - -python: - install: - - requirements: requirements.txt + python: "3.10" + commands: + - pip install -r requirements.txt + - python -m sphinx -T -E -j auto -b readthedocs -D language=en . $READTHEDOCS_OUTPUT/html From efdf52d0fd6d06bd8f797266e50f967215540b2f Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Thu, 31 Aug 2023 12:00:26 +0200 Subject: [PATCH 3/5] Config --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 7a9d09d..3c937f6 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,7 +1,7 @@ version: 2 build: - os: ubuntu-22.04 + os: "ubuntu-22.04" tools: python: "3.10" commands: From 9f4d838094c69af71d823a1e838701a12386f3b8 Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Thu, 31 Aug 2023 12:07:11 +0200 Subject: [PATCH 4/5] Update path --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 3c937f6..ddb84f6 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -6,4 +6,4 @@ build: python: "3.10" commands: - pip install -r requirements.txt - - python -m sphinx -T -E -j auto -b readthedocs -D language=en . $READTHEDOCS_OUTPUT/html + - python -m sphinx -T -E -j auto -b readthedocs -D language=en docs/ $READTHEDOCS_OUTPUT/html From 78f68915a47ae0e61cdcf8e2742276bbf791904a Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Thu, 31 Aug 2023 12:11:14 +0200 Subject: [PATCH 5/5] update builder --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index ddb84f6..71908d8 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -6,4 +6,4 @@ build: python: "3.10" commands: - pip install -r requirements.txt - - python -m sphinx -T -E -j auto -b readthedocs -D language=en docs/ $READTHEDOCS_OUTPUT/html + - python -m sphinx -T -E -j auto -b html -D language=en docs/ $READTHEDOCS_OUTPUT/html