[Yum-devel] [PATCH] Adds initial files for automatically generating html documentation.

James Antill james at fedoraproject.org
Wed Jul 20 16:13:21 UTC 2011


On Wed, 2011-07-20 at 11:08 -0400, Nick Jacek wrote:
> These files tell sphinx where to look in the source code to generate
> the documentation.  In the future, they could also be edited to add
> documentation about the modules that we want online, but not in the
> source code, such as long usage examples.  These files don't have to
> go in the git repo, but then I'm not sure where else to put them.
> Also, since sphinx can't generate the documentation without these
> files, if we don't put them in the git repo, I'm not sure it makes
> sense to put any of the sphinx config files at all in the repo.

 Ok, so they aren't automatically generated?

 Eg. the cli.rst file:

index 0000000..8679906
--- /dev/null
+++ b/docs/sphinxdocs/cli.rst
@@ -0,0 +1,27 @@
+cli
+===
+.. automodule:: cli
+
+.. autofunction:: sigquit
+
+CliError
+--------
+.. autoclass:: CliError
+   :members:
+   :show-inheritance:

...looks like it's just a dump of (part of) the documentation comments
in that file. Are you writing the above by hand?



More information about the Yum-devel mailing list