Test Builds

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.

  • datetime: shows different times (system time, build time, etc)
  • environment-variables: shows all the environment variables used to build the docs
  • yaml-v2: use a simple YAML for the V2 configuration
  • unicode-filename: has a page (rst) that its filename is unicode
  • ŭñíč°də-branch: the name of the branch is unicode
  • none-formats: use formats: [] so only HTML is built
  • requirements-not-found: use requirements_file: .notfound.txt
  • latest-image-py3.6: use build: image: latest and python: version: 3.6
  • use-py2: use python: version: 2
  • sphinx-1.8: use Sphinx<1.9 as requirement
  • 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
  • alabaster-theme: use alabaster as theme
  • typlog-theme: use typlog as theme
  • timeout: generate a timeout by sleeping 1000 seconds

Tags

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

Addind a new scenario to the repository

  1. Create a new branch from master using an appropiate name
  2. 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
  3. Add or modify the necessary files
    • Make sure that these files contains the minimum configuration needed:
      • remove auto generated comments
      • configs not used
  4. Push your changes
  5. Modify the README.rst file from master to add this new branch in the list

>>> # Build at
>>> import datetime
>>> datetime.datetime.utcnow()  # UTC
datetime.datetime(2018, 12, 5, 12, 21, 18, 761338)