add sphinx pluggin providing the autodocstring feature

1 files changed, 64 insertions, 0 deletions

diff --git a/sphinx_ext.py b/sphinx_ext.py
new file mode 100644
index 0000000..9bb82e6
--- /dev/null
+++ b/sphinx_ext.py
@@ -0,0 +1,64 @@
+from logilab.common.decorators import monkeypatch
+
+from sphinx.ext import autodoc
+
+class DocstringOnlyModuleDocumenter(autodoc.ModuleDocumenter):
+    objtype = 'docstring'
+    def format_signature(self):
+        pass
+    def add_directive_header(self, sig):
+        pass
+    def document_members(self, all_members=False):
+        pass
+
+#autodoc.add_documenter(DocstringOnlyModuleDocumenter)
+
+def setup(app):
+    app.add_autodocumenter(DocstringOnlyModuleDocumenter)
+
+
+
+from sphinx.ext.autodoc import (ViewList, Options, AutodocReporter, nodes,
+                                assemble_option_dict, nested_parse_with_titles)
+
+@monkeypatch(autodoc.AutoDirective)
+def run(self):
+    self.filename_set = set()  # a set of dependent filenames
+    self.reporter = self.state.document.reporter
+    self.env = self.state.document.settings.env
+    self.warnings = []
+    self.result = ViewList()
+
+    # find out what documenter to call
+    objtype = self.name[4:]
+    doc_class = self._registry[objtype]
+    # process the options with the selected documenter's option_spec
+    self.genopt = Options(assemble_option_dict(
+        self.options.items(), doc_class.option_spec))
+    # generate the output
+    documenter = doc_class(self, self.arguments[0])
+    documenter.generate(more_content=self.content)
+    if not self.result:
+        return self.warnings
+
+    # record all filenames as dependencies -- this will at least
+    # partially make automatic invalidation possible
+    for fn in self.filename_set:
+        self.env.note_dependency(fn)
+
+    # use a custom reporter that correctly assigns lines to source
+    # filename/description and lineno
+    old_reporter = self.state.memo.reporter
+    self.state.memo.reporter = AutodocReporter(self.result,
+                                               self.state.memo.reporter)
+    if self.name in ('automodule', 'autodocstring'):
+        node = nodes.section()
+        # necessary so that the child nodes get the right source/line set
+        node.document = self.state.document
+        nested_parse_with_titles(self.state, self.result, node)
+    else:
+        node = nodes.paragraph()
+        node.document = self.state.document
+        self.state.nested_parse(self.result, 0, node)
+    self.state.memo.reporter = old_reporter
+    return self.warnings + node.children