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

[autodoc] move config sample to annotation

Browse Source 
preserves link targets, which mangling the directive header does not
This commit is contained in:
Min RK
2019-05-03 13:00:25 +02:00
parent f97ef7eaac
commit ecafe4add9
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/sphinxext/autodoc_traits.py
View File

@@ -38,17 +38,18 @@ class TraitDocumenter(AttributeDocumenter):
def can_document_member(cls, member, membername, isattr, parent): def can_document_member(cls, member, membername, isattr, parent):
return isinstance(member, TraitType) return isinstance(member, TraitType)
def format_name(self):
return 'config c.' + super().format_name()
def add_directive_header(self, sig): def add_directive_header(self, sig):
default = self.object.get_default_value() default = self.object.get_default_value()
if default is Undefined: if default is Undefined:
default_s = '' default_s = ''
else: else:
default_s = repr(default) default_s = repr(default)
sig = ' = {}({})'.format(self.object.__class__.__name__, default_s) self.options.annotation = 'c.{name} = {trait}({default})'.format(
return super().add_directive_header(sig) name=self.format_name(),
trait=self.object.__class__.__name__,
default=default_s,
)
super().add_directive_header(sig)
def setup(app): def setup(app):