3 ms·
> is it possible to include a folder with md files in the output? Not yet, but integrating your API documentation into the rest of your website/docs is definit
by mhils 6y ago
> is it possible to include a folder with md files in the output?
Not yet, but integrating your API documentation into the rest of your website/docs is definitely something that I have on the radar. I'm not sure what this will look like eventually. :-) If you have specific ideas, please do open an issue on GitHub for some brainstorming!
> any plans to suppport `##` or `# #` (for pep8) similar to rust's `///`?
Unlikely. To generate documentation, we introspect the loaded module and also walk the abstract syntax tree. Python's builtin AST does not include comments, so there's no easy way for us to access them. Honestly, I think the """docstrings""" convention is reasonable enough and widely adopted in the Python ecosystem. Is that missing any use cases?
- kylebarron 6y ago> integrating your API documentation into the rest of your website/docs is definitely something that I have on the radar I think that Sphinx and mkdocs are the two most popular docs systems for Python, and Sphinx can build its own API docs, so a closer integration into mkdocs might be worth looking into. Mkdocs has a plugin system now that you can hook in to [0]: https://www.mkdocs.org/user-guide/plugins/ https://www.mkdocs.org/user-guide/plugins/
- woile 6y agoMkdocs has a plugin to generate apidocs as well https://github.com/tomchristie/mkautodoc https://github.com/tomchristie/mkautodoc