Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
humitos committed Apr 28, 2020
1 parent d39922f commit 4f4b423
Showing 1 changed file with 5 additions and 34 deletions.
39 changes: 5 additions & 34 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,43 +14,14 @@ the issue number and the repository, like: ``issue-1234-org``, ``issue-4321-ext`
Scenarios
---------

Each of these scenarios is a branch that can be built independenly from the others.
Each of these scenarios is a branch that can be built independently from the others.

* `alabaster-theme <https://test-builds.readthedocs.io/en/alabaster-theme/>`_: use ``alabaster`` as theme
* `auto-wipe <https://test-builds.readthedocs.io/en/auto-wipe/>`_: used for auto wipe the environment when a config is changed
* `branch/with/slashes <https://test-builds.readthedocs.io/en/branch-with-slashes/>`_: used to check that git clones without problem
* `conda-env <https://test-builds.readthedocs.io/en/conda-env/>`_: use a simple conda environment to build the docs
* `conda-env-py3.7 <https://test-builds.readthedocs.io/en/conda-env-py3.7/>`_: use a simple conda environment to build the docs with Python 3.7
* `datetime <https://test-builds.readthedocs.io/en/datetime/>`_: shows different times (system time, build time, etc)
* `environment-variables <https://test-builds.readthedocs.io/en/environment-variables/>`_: shows all the environment variables used to build the docs
* `huge-build-output <https://test-builds.readthedocs.io/en/huge-build-output/>`_: generate megabytes of output data for commands
* `none-formats <https://test-builds.readthedocs.io/en/none-formats/>`_: use ``formats: []`` so only HTML is built
* `requirements-not-found <https://test-builds.readthedocs.io/en/requirements-not-found/>`_: use ``requirements_file: .notfound.txt``
* `robots-txt <https://test-builds.readthedocs.io/en/robots-txt/>`_: use a custom ``robots.txt`` for this project
* `search-with-old-sphinx-and-theme <https://test-builds.readthedocs.io/en/search-with-old-sphinx-and-theme/>`_: search box on old Sphinx and RTD theme version
* `timeout <https://test-builds.readthedocs.io/en/timeout/>`_: generate a timeout by sleeping 1000 seconds
* `typlog-theme <https://test-builds.readthedocs.io/en/typlog-theme/>`_: use ``typlog`` as theme
* `ŭñíč°də-branch <https://test-builds.readthedocs.io/en/ŭñíč°də-branch/>`_: the name of the branch is unicode
* `unicode-filename <https://test-builds.readthedocs.io/en/unicode-filename/>`_: has a page (rst) that its filename is unicode
* `use-py2 <https://test-builds.readthedocs.io/en/use-py2/>`_: use ``python: version: 2``
* `yaml-v2 <https://test-builds.readthedocs.io/en/yaml-v2/>`_: use a simple YAML for the V2 configuration
Please, check `all the branches <https://github.com/readthedocs/test-builds/branches/>`_ and
`all the tags <https://github.com/readthedocs/test-builds/tags/>`_ to be sure.


.. note::

There could be more scenarios probably, but this list is not always up to date.
Please, check `all the branches <https://github.com/rtfd/test-builds/branches/>`_ to be sure.

Tags
----

We also have some tags to have some tests around this.

* `tag-v1 <https://test-builds.readthedocs.io/en/tag-v1/>`_: points to an specific commit
* `tag-v2 <https://test-builds.readthedocs.io/en/tag-v2/>`_: points to the same commit than ``tag-v1`` (`Delete tags with same commit <https://github.com/rtfd/readthedocs.org/pull/4915>`_)


Addind a new scenario to the repository
Adding a new scenario to the repository
---------------------------------------

#. Create a new branch from ``master`` using an appropiate name
Expand All @@ -61,7 +32,7 @@ Addind a new scenario to the repository
#. 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
Expand Down

0 comments on commit 4f4b423

Please sign in to comment.