Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Browse files

Added basic README

  • Loading branch information...
commit e5bc9825b19741197a34cc644650ee04cf5fa10b 1 parent 0dde4c0
Michael Jones authored
Showing with 36 additions and 0 deletions.
  1. +36 −0 README.rst
36 README.rst
@@ -0,0 +1,36 @@
+A Sphinx extension which provides a directive to automatically extract a node's
+documentation from an appropriately written Attribute Editor Template.
+The directive is designed to extract and format the per-control annotations from
+the Attribute Editor and can only work if the Attribute Editor Template has been
+written in Python.
+The code is in early stages and hasn't be tested with complex production
+It is always a shame to document something twice, so if you have complete
+annotations on your Attribute Editor controls then it makes sense to reuse them
+for the project's official documentation.
+You use the ``mayanode`` directive in you Sphinx docs in the following way::
+ .. mayanode:: <module>:<function>
+Where ``<module>`` is the name of the module in which your Attribute Editor
+Template code is written and ``<function>`` is the entry function in which it

0 comments on commit e5bc982

Please sign in to comment.
Something went wrong with that request. Please try again.