fetchai/cosmpy

Automatic addition of reference API into mkdocs

Opened this issue · 0 comments

5A11 commented

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