[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Discuss-gnuradio] Documentation generation using Sphinx

From: Ben Reynwar
Subject: [Discuss-gnuradio] Documentation generation using Sphinx
Date: Wed, 29 Feb 2012 13:26:47 -0700

Hi all,

Every 6 months or so I have a crack at getting some python level
documentation working.  In this attempt, I've generated documentation
for the gr and digital modules using sphinx.

The generated html is at:

Source for the generated documentation is at:

The documentation generation is semi-automatic.  I created files
containing lists of the objects we want to document, and organized
them into categories.  The actual documentation itself was pulled from
the docstrings automatically.  It would be necessary to manually edit
files when new blocks or other objects are added, so there is a danger
that this kind of documentation could become incomplete, however
because the content is taken from the docstrings it should remain
accurate, if not complete.

Are there any objections to me continuing down this path of
documentation generation?  Any suggestions?


reply via email to

[Prev in Thread] Current Thread [Next in Thread]