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 # ...
x-custom-steps:
- echo "Custom steps to build documentation at $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.
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.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 39f4dd1d21920c44db2c116a40fae8d67fc60ae68faf82df61b3bba52d5811b8 |
|
MD5 | 431bb9ebce14f61691bacbe23abb80a4 |
|
BLAKE2b-256 | 124b2979604f7269a38bbcfee639864f1bf8215d2321472f809ddaf947f9a092 |
Hashes for readthedocs_custom_steps-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8b6c68477d69a938d52b90693033444cdeb79cc8b3429d2816999d06b5e135c9 |
|
MD5 | a796b4b935965c8e33d04816ca033b3c |
|
BLAKE2b-256 | 51ab3bb9eee3c78b6ff462c86fbb82133d02de8b843e3ebf2c360c82a6552862 |