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

Automatic addition of reference API into mkdocs #282

Open
3 tasks done
5A11 opened this issue Sep 15, 2022 · 0 comments
Open
3 tasks done

Automatic addition of reference API into mkdocs #282

5A11 opened this issue Sep 15, 2022 · 0 comments

Comments

@5A11
Copy link
Member

5A11 commented Sep 15, 2022

Prerequisites

  • I checked the documentation and made sure this feature does not already exist.
  • I checked the existing issues to make sure this feature has not already been requested.
  • I have read the code of conduct before creating this issue.

Problem

No response

Feature / Solution

Currently the reference API is generated but has to be manually added to MKDocs.yaml.

Investigate if hit is possible to automatically add those pages in the existing MKDocs.yaml file.

===========

See
https://niklasrosenstein.github.io/pydoc-markdown/getting-started/
and
https://niklasrosenstein.github.io/novella/

These can also be run in CI as part of ensuring the API reference is in fact in mkdocs.yaml.

Alternatives

No response

Additional Context

No response

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

No branches or pull requests

1 participant