Merge pull request #143 from tetov/class-docstring-fix

Fixes for class docs

Author: gonzalocasas

docs/conf.py

@@ -4,6 +4,8 @@
 import os
 import sphinx_compas_theme
 
+from sphinx.ext.napoleon.docstring import NumpyDocstring
+
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
@@ -46,7 +48,6 @@
 # autodoc options
 autodoc_default_options = {
     'member-order': 'bysource',
-    'special-members': '__init__',
     'exclude-members': '__weakref__',
     'undoc-members': True,
     'private-members': True,
@@ -93,3 +94,38 @@
 napoleon_use_param = False
 napoleon_use_rtype = False
 
+# Parse Attributes and Class Attributes on Class docs same as parameters.
+# first, we define new methods for any new sections and add them to the class
+
+
+def parse_keys_section(self, section):
+    return self._format_fields('Keys', self._consume_fields())
+
+
+NumpyDocstring._parse_keys_section = parse_keys_section
+
+
+def parse_attributes_section(self, section):
+    return self._format_fields('Attributes', self._consume_fields())
+
+
+NumpyDocstring._parse_attributes_section = parse_attributes_section
+
+
+def parse_class_attributes_section(self, section):
+    return self._format_fields('Class Attributes', self._consume_fields())
+
+
+NumpyDocstring._parse_class_attributes_section = parse_class_attributes_section
+
+
+# we now patch the parse method to guarantee that the the above methods are
+# assigned to the _section dict
+def patched_parse(self):
+    self._sections['keys'] = self._parse_keys_section
+    self._sections['class attributes'] = self._parse_class_attributes_section
+    self._unpatched_parse()
+
+
+NumpyDocstring._unpatched_parse = NumpyDocstring._parse
+NumpyDocstring._parse = patched_parse