Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Autotest Sphinx-based Documentation infrastructure #619

Closed
wants to merge 7 commits into from

Conversation

clebergnu
Copy link
Member

It's been a while since we've discussed the current state of
Autotest's documentation. While the content has been updated
frequently via the wiki, the current infrastructure is not ideal.

We evaluated many possibilities and we understood that going with
Sphinx (sphinx-doc.org) is our best option. The idea is to move
all documentation from the wiki to Autotest main repo. Doing this,
we'll have:

  • Per branch/release documentation
  • Documentation attached to patches that introduce new features

And all the other goodies that Sphinx gives us for free, such as
multiple output support and cross reference with other project's
documentation. This last feature is very important because it will
allow say, virt-test, to have a documentation that references
autotest base libraries very easily. The same thing applies to
applications based on ARC, that use the interface the RPC server
offers.

Besides the infrastruture that this patchset brings, there's also
a first attempt to document the RPC server.

In the near future I hope we'll be able to improve even more the
state of our documentation by using sphinx's extension support.
The first extensions in development to suit our own needs:

  • Better auto documentation of Django models
  • Auto documentation of optparse.OptionParser instances so that
    we'll have auto-generated man pages.

Please git this a try. You can build the documentation by running:

$ python setup.py build_doc

This will generate the html output on build/sphinx/html.

To make room for more central documentation files.

Signed-off-by: Cleber Rosa <crosa@redhat.com>
Signed-off-by: Cleber Rosa <crosa@redhat.com>
As this is a directory that is used by sphinx to store files during
the build and after the build is completed and a given (say html)
output is generated.

Signed-off-by: Cleber Rosa <crosa@redhat.com>
Signed-off-by: Cleber Rosa <crosa@redhat.com>
Signed-off-by: Cleber Rosa <crosa@redhat.com>
Signed-off-by: Cleber Rosa <crosa@redhat.com>
Signed-off-by: Cleber Rosa <crosa@redhat.com>
@lmr
Copy link
Member

lmr commented Apr 5, 2013

Cleber, thank you very much. This is very useful, applied to next!

@lmr lmr closed this Apr 5, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants