search

jcayers20 / mkdocs-autoapi

MkDocs plugin providing automatic API reference generation
MIT License
2 stars 0 forks source link

Documentation: Add Live Examples #28

Open jcayers20 opened 1 month ago

jcayers20 commented 1 month ago

The documentation provides code block examples of setting up mkdocs-autoapi, but I think links to live examples would be helpful. The idea is to create a repository (or repositories) containing examples of projects with different structures and content, then add links to those examples to the documentation.

jcayers20 commented 6 hours ago

I'm going to hold off on adding this until a future version, as I'll likely want to completely revamp the documentation once these are ready. Removing this from the 0.3.0 milestone; likely plan is to complete this as part of v0.4.0.