[PATCH 0/6] Try harder to get API docs up on readthedocs.org
Martin Kolman
mkolman at redhat.com
Thu Jul 24 08:59:14 UTC 2014
On Wed, 2014-07-23 at 14:23 -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.
>
> David Lehman (6):
> Add API docs.
> Order module members by position in source instead of alphabetically.
> Change title of top-level module list to API.
> Don't remove api docs every time you make a doc target.
> Mock selinux when building docs.
> Fix sphinx formatting of clode blocks in devicefactory docstrings.
^^^^^ typo ?
>
> .gitignore | 4 -
> blivet/devicefactory.py | 6 +-
> doc/Makefile | 1 -
> doc/blivet.devicelibs.rst | 102 +++++++++++++++++++++++
> doc/blivet.formats.rst | 120 ++++++++++++++++++++++++++++
> doc/blivet.rst | 200 ++++++++++++++++++++++++++++++++++++++++++++++
> doc/conf.py | 2 +-
> doc/index.rst | 2 +-
> doc/modules.rst | 7 ++
> 9 files changed, 434 insertions(+), 10 deletions(-)
> create mode 100644 doc/blivet.devicelibs.rst
> create mode 100644 doc/blivet.formats.rst
> create mode 100644 doc/blivet.rst
> create mode 100644 doc/modules.rst
>
More information about the anaconda-patches
mailing list