[PATCH 0/6] Try harder to get API docs up on readthedocs.org

Brian C. Lane bcl at redhat.com
Wed Jul 23 20:35:58 UTC 2014


On Wed, Jul 23, 2014 at 02:23:57PM -0500, David Lehman wrote:
> I finally have some understanding of sphinx autodoc.
> 
> The makefile in doc/ runs sphinx-apidoc before running sphinx-build -- that's
> where the API docs come from. Since readthedocs runs sphinx-build directly
> (without running sphinx-apidoc first) there are no API docs generated there.
> The obvious solution is to keep the API docs in git so they are in place for
> readthedocs' build. We'll have to update them if we move/add/remove modules,
> but that should be about it as far as maintenence. We can always run
> sphinx-apidoc again, change the title in the modules.rst file, add the
> member-order option throughout, and update them wholesale if we want to.

Great! These look good to me.

-- 
Brian C. Lane | Anaconda Team | IRC: bcl #anaconda | Port Orchard, WA (PST8PDT)


More information about the anaconda-patches mailing list