NiklasRosenstein / pydoc-markdown

Create Python API documentation in Markdown format.
http://niklasrosenstein.github.io/pydoc-markdown/
Other
458 stars 102 forks source link

Better MkDocs support on Read the Docs #206

Open NiklasRosenstein opened 3 years ago

NiklasRosenstein commented 3 years ago

Is your feature request related to a problem? Please describe.

Describe the solution you'd like

Read the Docs kicks of MkDocs builds like this:

$ /home/docs/.../bin/python -m mkdocs build --clean --site-dir _build/html --config-file mkdocs.yml 

And with readthedocs-custom-steps, we still have access to all of these arguments starting with mkdocs. Pydoc-Markdown could have a mode where arguments are passed to the renderer directly, for example

$ pydoc-markdown -- "$@"

Which can then parse the --site-dir as well as the --config-file.