readthedocs-custom-steps 0.3.0.post1

A hack to run custom steps when building documentation on Read the Docs.

readthedocs-custom-steps

A hack to run custom steps when building documentation on Read the Docs.

Configuration

# .readthedocs.yml
version: 2
mkdocs: {}  # tell readthedocs to use mkdocs
python:
  version: 3.7
  install:
    - requirements: requirements.txt  # must contain "readthedocs-custom-steps"

# .readthedocs-custom-steps.yml
steps:
- echo "Custom steps to produce HTML in $SITE_DIR here ..."

Important: This module should not be installed outside of a Read the Docs build environment. It will rename your Python executable and install a substitute. It does not currently provide an automated way to revert this change.

Testing this package

To test this package in a similar environment as Read the Docs itself, you can run make test. Note that this requires Docker and a Docker volume called pip-caches. Note that the Make command is expected to return status code 27 as defined in the test/.readthedocs-custom-steps.yml file.

Release process

Requires Shore.

$ make bump TYPE=--minor
$ make publish

---

Copyright © 2020 Niklas Rosenstein