generate or link to API docs about mkdocs HOT 7 CLOSED

I wrote a simple generator to generate API docs by parsing source. https://github.com/raghakot/markdown-apidocs

I came here looking for a solution, couldn't find anything satisfactory online and built my own. Hope it helps others who stumble here looking for a workaround.

from mkdocs.

I'd also have been interested in this. If this can be of any use to anyone, I've written an extremely basic automatic API doc generator that extracts docstrings of modules, functions, classes, methods, and properties, and outputs an api.md document. This document can then be used in mkdocs. There's probably some more work to do to make it prettier...

from mkdocs.

Autogenerated docs isn't something I'm particular interested in pulling into mkdocs. The best documentation sites that I've seen don't tend to include autogenerated docs.

I'm not sure of the specfics of what you mean with linking to existing html pages, but there's two routes I can see to this sort of use case:

1. I'm planning for you to be able to add regular HTML pages as well as MD pages.
2. Alternatively just manually hyperlink to autogenerated docs.

I'm guessing (1) is really what you're looking for right?

from mkdocs.

#1 would be great! Adding Sphinx-generated html (for example) would work perfectly for me.

Thank you.

from mkdocs.

Closing this in favor of #28

from mkdocs.

@rossant If you are generating a Markdown file, why don't you just create that in your other documentation and have it built by MkDocs. Then you don't need to do any extra linking.

from mkdocs.

@rossant I am using your automatic doc generation for one of my projects. Thanks for your work!

from mkdocs.