« Previous | Next » 

Revision 6d81475c

ID6d81475ca04828b3e849541581ad6008b0dc81c6

Added by Iustin Pop almost 15 years ago

Convert from auto-generated RAPI docs to static

This patch removes the autogeneration of the RAPI docs from the code
(based on docstrings) and moves the current autogenerated output to
the rapi.rst file.

The reasons behind this are multiple:
- the build system becomes a little more simple (this could have been
achieved also by distributing the built documentation, though)
- it's hard to actually write documentation in docstrings; you have to
fit restructured text inside the docstrings, and this results in
not really nice output
- even by being close to the code, the documentation manages to get
out of sync (not paying attention to docstrings)

This will also help with the move to sphinx.

Signed-off-by: Iustin Pop <>
Reviewed-by: Guido Trotter <>

Files

  • added
  • modified
  • copied
  • renamed
  • deleted

View differences