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

Handle traitlets 4.x

Browse Source
This commit is contained in:
Min RK
2017-02-21 18:06:48 +01:00
parent 08e8c93b16
commit 1d19684b2c
1 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/sphinxext/autodoc_traits.py
View File

@@ -1,6 +1,6 @@
"""autodoc extension for configurable traits""" """autodoc extension for configurable traits"""
from traitlets import TraitType from traitlets import TraitType, Undefined
from sphinx.domains.python import PyClassmember from sphinx.domains.python import PyClassmember
from sphinx.ext.autodoc import ClassDocumenter, AttributeDocumenter from sphinx.ext.autodoc import ClassDocumenter, AttributeDocumenter
@@ -37,9 +37,14 @@ class TraitDocumenter(AttributeDocumenter):
return 'config c.' + super().format_name() return 'config c.' + super().format_name()
def add_directive_header(self, sig): def add_directive_header(self, sig):
sig = ' = {}(default={!r})'.format( default = self.object.get_default_value()
if default is Undefined:
default_s = ''
else:
default_s = repr(default)
sig = ' = {}({})'.format(
self.object.__class__.__name__, self.object.__class__.__name__,
self.object.default(), default_s,
) )
return super().add_directive_header(sig) return super().add_directive_header(sig)