Package description here.
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: 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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8279da932388e297ed4287b135472bacbcb0c77c0eb25105a3f79b6d0c728107 |
|
MD5 | fe3d96a5ed992af6ca2979f8d3f21dd2 |
|
BLAKE2b-256 | 369c9989042bb33c41bd41e986df6526ba88b6b0210b542c77874fe557fd9dd9 |
Hashes for readthedocs_custom_steps-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b9201d5d6c178e574bf4e2193f4747189a424764e2ca7077d70eb256d827e253 |
|
MD5 | bcc2a7bdb19c8f922fa5f20a9ba16f4d |
|
BLAKE2b-256 | 9f4f7f79f761130d0ed0491d757b6bb067397c39a72c129837dcf1d8467d7955 |