Skip to content

Commit

Permalink
change doc config
Browse files Browse the repository at this point in the history
  • Loading branch information
mjsandells committed Oct 9, 2022
1 parent 1dc7a6b commit e718548
Showing 1 changed file with 4 additions and 12 deletions.
16 changes: 4 additions & 12 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@ def rst_link_transform(docname):
napoleon_include_init_with_doc = True
napoleon_include_private_with_doc = False
napoleon_include_special_with_doc = True
napoleon_use_admonition_for_examples = False
napoleon_use_admonition_for_notes = False
napoleon_use_admonition_for_references = False
napoleon_use_admonition_for_examples = True
napoleon_use_admonition_for_notes = True
napoleon_use_admonition_for_references = True
napoleon_use_ivar = False
napoleon_use_param = True
napoleon_use_rtype = True
Expand All @@ -92,15 +92,7 @@ def rst_link_transform(docname):

autosummary_generate = True
templates_path = ['_templates']
exclude_patterns = ['_build', '_templates', '**test**', 'setup']

autodoc_default_options = {
'members': 'smrt, smrt.input',
'member-order': 'bysource',
'special-members': '__init__',
'undoc-members': False,
'exclude-members': '__weakref__'
}
exclude_patterns = ['_build', '_templates', '**test**']


# From https://stackoverflow.com/questions/39249466/how-to-exclude-pytest-test-functions-from-sphinx-autodoc
Expand Down

0 comments on commit e718548

Please sign in to comment.