Statistics
| Branch: | Tag: | Revision:

root / lib / build @ d59633a6

Name Size
__init__.py 1.2 kB
shell_example_lexer.py 2.1 kB
sphinx_ext.py 16.8 kB

Latest revisions

# Date Author Comment
d59633a6 02/25/2013 02:13 pm Michael Hanselmann

sphinx_ext: New directive for supported methods

Until now many resources, but not all and not consistently list their
supported methods (e.g. “Supports the following commands: ``GET`` …”).
Not only is it easy for this list to get out of date, but it would also...
aa82eb62 02/25/2013 02:13 pm Michael Hanselmann

sphinx_ext: Factorize getting RAPI handlers

The list of resources and handlers will also be used for generating
a per-resource table.

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Guido Trotter <>
60b47261 02/25/2013 02:13 pm Michael Hanselmann

sphinx_ext: Factorize handler methods/access

The factorized parts will be used to show a small table with methods and
required permissions for each resource.

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Guido Trotter <>
61c13f94 02/25/2013 02:13 pm Michael Hanselmann

Use "none" instead of "everyone" in RAPI documentation

The list of required access permissions uses the word “everyone” to mean
“no special permissions are needed”. The word “none” fits better.

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Guido Trotter <>
1302ce18 02/22/2013 12:51 pm Michael Hanselmann

Improve RAPI documentation on users and options

- Document fields in “rapi/users” file in the order they appear
(username, password, options)
- Mention new “--require-authentication” option
- Clarify use of “write” on “GET” method

Signed-off-by: Michael Hanselmann <>...
5d0b2888 02/22/2013 12:51 pm Michael Hanselmann

sphinx_ext: Drop text map for RAPI permissions

Other parts of the documentation directly refer to the constants through
“pyeval”. There's no need for this map as it's just additional work to
maintain.

Signed-off-by: Michael Hanselmann <>...
daff2f81 02/20/2013 01:28 pm Michael Hanselmann

Build table with access permissions for RAPI resources

Sometimes it can be difficult to determine the access permissions needed
for a certain RAPI resource without looking at code. This table, added
at the end of “rapi.rst”, shows all resources and the permissions needed...
c6793656 02/19/2013 04:29 pm Michael Hanselmann

Sphinx extension: Module-level constant for tab width

Use a module-level constant for the tab width.

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Michele Tartara <>
46ab58d4 02/19/2013 04:29 pm Michael Hanselmann

RAPI documentation: Assertion for console fields

Assert that the documented fields are equal to those in the actual
object.

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Guido Trotter <>
5ce58234 01/15/2013 04:43 pm Michael Hanselmann

Link man pages in documentation

This patch depends on “Option to include man pages in documentation”. In
the documentation build including man pages, all “:manpage:`…`”
references are converted to links. For man pages not provided by Ganeti,
Sphinx' standard formatting is used....

View revisions

Also available in: Atom