Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better MkDocs support on Read the Docs #206

Open
NiklasRosenstein opened this issue Aug 17, 2021 · 0 comments
Open

Better MkDocs support on Read the Docs #206

NiklasRosenstein opened this issue Aug 17, 2021 · 0 comments
Assignees

Comments

@NiklasRosenstein
Copy link
Owner

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

  • Read the Docs injects some custom values into the MkDocs configuration (mostly extra CSS and JS), and Pydoc-Markdown should pick that up.
  • Pydoc-Markdown should also pick up the --site-dir argument which is where Read the Docs expects the HTML content to go to. The current workaround is to manually pass --site-dir $PWD/_build/html as an argument to Pydoc-Markdown.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant