A hack to run custom steps when building documentation on Read the Docs.
Project description
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 -f test/Makefile
.
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-config.yml
file.
Release process
Bump the version number:
$ shore -C readthedocs-custom-steps bump --minor --tag --push
Publish to PyPI:
$ SETUPTOOLS_BUILD=True shore -C readthedocs-custom-steps publish pypi
Copyright © 2020 Niklas Rosenstein
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for readthedocs-custom-steps-0.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2aabb264416a16741befa9636dbf0ec4da640aa9a133d9129997f5cd5946e7e5 |
|
MD5 | 6aac11dabc6f6d1d926311a332495f10 |
|
BLAKE2b-256 | ee93a6c60d7f538306500f067d20e377a65aed33052343464a0f1449d77c7b9f |
Hashes for readthedocs_custom_steps-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3669a0caed863741f2eb809542db53f079bc183521add8028a3573660497b1d0 |
|
MD5 | 64c648327c5fbfb3e95d1e7424691d96 |
|
BLAKE2b-256 | 72f683bc952adb95ce967e39c3ceb92a8b7431574fcd53dc88124a8310de06bd |