I'd like to accomplish two things with this email.
1. See if anybody has a problem adding dependencies to the docs build
So first, the docs build system is set up to automatically document the
Python client (and ORT.py), but relies on importing the package to
document it. That means that the dependencies of the package need to
exist or the generated documentation is empty
(e.g.:
https://traffic-control-cdn.readthedocs.io/en/latest/tools/python_client.html)
So at this point we have three options as I see it
1. Stop auto-documenting
I hate this idea. Automated documentation is a godsend. Let's not
choose this one.
2. Add the dependencies to requirements.txt
This is currently the most appealing to me. I think if we just add
`distro`
and `munch` everything will be fine. It does mean maintaining
dependencies in two
different places.
3. Separate dependencies into "base" and "you need these for autodoc"
This may sound nice at first glance, but the work it takes to get that
to work with
ReadTheDocs is non-negligible. Probably means adding some custom
scripting to
conf.py.
2. Gauge interest in a new docs output format
Does anybody use Dash/Zeal/Velocity/Xcode when working with the ATC repo?
We can use the built sphinx documentation to generate docsets that will
integrate
into those. If it's common enough, I could add it as a build target for the
docs.
