Autotest Sphinx-based Documentation infrastructure #619
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
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:
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.