search

databio / mkdocs-databio

Lab theme for mkdocs
BSD 2-Clause "Simplified" License
3 stars 1 forks source link

add usage autodocumenting #2

Open nsheff opened 5 years ago

nsheff commented 5 years ago

The command line usage could auto-document.

nsheff commented 5 years ago

running into this again... not sure of the best way to do it though... probably something similar to what we're doing with the jupyter builds

nsheff commented 5 years ago

the problem with making this happen automatically is that, like the API stuff, it requires the package to be installed. This makes it harder to update just the docs, if you aren't on a system with everything installed at the latest version...

is there a way to pass a command to mkdocs serve and mkdocs build to turn on/off the autodocs ?

vreuter commented 5 years ago

Maybe; it probably depends on whether click has a hook for provision/acceptance of ad-hoc CLI options, since that's what mkdocs is using to handle CLI definition and usage