doc: autodoc for init

test syntax for autolinking to types
test syntax to avoid evaluating enum arguments to numbers
This commit is contained in:
Laurens Valk
2018-12-28 16:40:01 +01:00
parent e94b54c380
commit d5dedc7924
3 changed files with 9 additions and 1 deletions
+1 -1
View File
@@ -89,7 +89,7 @@ todo_include_todos = True
autodoc_member_order = 'bysource' autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'undoc-members'] autodoc_default_flags = ['members', 'undoc-members']
autoclass_content = 'both' # This ensures init arguments are not ignored but added to class docstring.
# -- Options for HTML output ---------------------------------------------- # -- Options for HTML output ----------------------------------------------
+7
View File
@@ -0,0 +1,7 @@
:mod:`ev3devices` -- Title
==========================
Intro
.. automodule:: ev3devices
+1
View File
@@ -11,6 +11,7 @@ Welcome to Pybricks's documentation!
:caption: EV3 Modules: :caption: EV3 Modules:
parameters parameters
ev3devices