hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-10 03:23:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

blacken autodoc sphinx extension

Browse Source
This commit is contained in:
Carol Willing
2018-06-06 12:57:14 -07:00
parent ff7851ee2e
commit 6821ad0c59
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/sphinxext/autodoc_traits.py
View File

@@ -7,14 +7,18 @@ from sphinx.ext.autodoc import ClassDocumenter, AttributeDocumenter
class ConfigurableDocumenter(ClassDocumenter): class ConfigurableDocumenter(ClassDocumenter):
"""Specialized Documenter subclass for traits with config=True""" """Specialized Documenter subclass for traits with config=True"""
objtype = 'configurable' objtype = 'configurable'
directivetype = 'class' directivetype = 'class'
def get_object_members(self, want_all): def get_object_members(self, want_all):
"""Add traits with .tag(config=True) to members list""" """Add traits with .tag(config=True) to members list"""
check, members = super().get_object_members(want_all) check, members = super().get_object_members(want_all)
get_traits = self.object.class_own_traits if self.options.inherited_members \ get_traits = (
else self.object.class_traits self.object.class_own_traits
if self.options.inherited_members
else self.object.class_traits
)
trait_members = [] trait_members = []
for name, trait in sorted(get_traits(config=True).items()): for name, trait in sorted(get_traits(config=True).items()):
# put help in __doc__ where autodoc will look for it # put help in __doc__ where autodoc will look for it
@@ -42,10 +46,7 @@ class TraitDocumenter(AttributeDocumenter):
default_s = '' default_s = ''
else: else:
default_s = repr(default) default_s = repr(default)
sig = ' = {}({})'.format( sig = ' = {}({})'.format(self.object.__class__.__name__, default_s)
self.object.__class__.__name__,
default_s,
)
return super().add_directive_header(sig) return super().add_directive_header(sig)