Metadata-Version: 2.1
Name: readthedocs-custom-steps
Version: 0.2.1
Summary: A hack to run custom steps when building documentation on Read the Docs.
Home-page: UNKNOWN
Author: Niklas Rosenstein
Author-email: rosensteinniklas@gmail.com
License: UNKNOWN
Description: # readthedocs-custom-steps
        
        A hack to run custom steps when building documentation on Read the Docs. 
        
        __Configuration__
        
        ```yml
        # .readthedocs.yml
        version: 2
        mkdocs: {}  # tell readthedocs to use mkdocs
        python:
          version: 3.7
          install:
            - requirements: requirements.txt  # must contain "readthedocs-custom-steps"
        ```
        
        ```yml
        # .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
        
        ---
        
        <p align="center">Copyright &copy; 2020 Niklas Rosenstein</p>
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
