Skip to content

Read the Docs

Using Pydoc-Markdown on readthedocs.org requires some "hacking" because natively it does not allow you to run any custom commands. Using readthedocs-custom-steps, you can hook into the call that RTD expects to generate the documentation using Sphinx/MkDocs and run your own commands instead.

Example

version: 2
mkdocs: {}  # tell readthedocs to use mkdocs
python:
  version: 3.7
  install:
  - method: pip
    extra_requirements:
    - rtd
[options.extras_require]
rtd = readthedocs-custom-steps==0.6.2
# ...

[tool.readthedocs-custom-steps]
script = """
novella --site-dir _site/html
"""