Skip to content
This repository has been archived by the owner on Aug 27, 2024. It is now read-only.

Enhance html generation in Netlify for the lazydocs markdown files #104

Open
SamVanhoutte opened this issue Dec 9, 2021 · 1 comment
Open
Labels
documentation All issues related to documentation enhancement New feature or request

Comments

@SamVanhoutte
Copy link
Contributor

Describe the bug
Currently, netlify takes the markdown files of the API documentation and adds them in the table of content. But there are several layout issues in the rendering of things. It would be good to have this enhanced.

@SamVanhoutte SamVanhoutte added documentation All issues related to documentation enhancement New feature or request labels Dec 9, 2021
@SamVanhoutte
Copy link
Contributor Author

I believe it would be good to discuss this with @Mcalewaert , as how to integrate the generated documentation in the final documentation website.
LazyDocs seemed to be the best & most lightweight solution , where some others seemed more complex (and might be better suited, if someone can take the time):

  • Sphinx: most feature rich - quite complex
  • Pydoc: was used in the initial builds, but that generates HTML. Don't know if that would be easy to integrate in the doc-workflow?

Interesting stackoverflow question on this: https://stackoverflow.com/questions/36237477/python-docstrings-to-github-readme-md

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation All issues related to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant