Skip to content
29 changes: 15 additions & 14 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,20 +46,21 @@
# Consider enabling numpydoc validation. See:
# https://numpydoc.readthedocs.io/en/latest/validation.html#
numpydoc_validate = True
numpydoc_validation_checks = {
"GL06", # Found unknown section
"GL07", # Sections are in the wrong order.
# "GL08", # The object does not have a docstring
"GL09", # Deprecation warning should precede extended summary
"GL10", # reST directives {directives} must be followed by two colons
"SS01", # No summary found
# "SS02", # Summary does not start with a capital letter
# "SS03", # Summary does not end with a period
# "SS04", # Summary contains heading whitespaces
# "SS05", # Summary must start with infinitive verb, not third person
"RT02", # The first line of the Returns section should contain only the
# type, unless multiple values are being returned"
}
numpydoc_validation_checks = set() # numpydoc validation is turned off due to performance (see PR#44)
#numpydoc_validation_checks = {
# "GL06", # Found unknown section
# "GL07", # Sections are in the wrong order.
# # "GL08", # The object does not have a docstring
# "GL09", # Deprecation warning should precede extended summary
# "GL10", # reST directives {directives} must be followed by two colons
# "SS01", # No summary found
# # "SS02", # Summary does not start with a capital letter
# # "SS03", # Summary does not end with a period
# # "SS04", # Summary contains heading whitespaces
# # "SS05", # Summary must start with infinitive verb, not third person
# "RT02", # The first line of the Returns section should contain only the
# # type, unless multiple values are being returned"
#}

# Path to static files
html_static_path = ["_static"]
Expand Down
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ description = Check if documentation generates properly
deps =
-r{toxinidir}/requirements/requirements_doc.txt
commands =
sphinx-build -d "{toxworkdir}/doc_doctree" doc/source "{toxworkdir}/doc_out" --color -vW -b html
sphinx-build -d "{toxworkdir}/doc_doctree" doc/source "{toxworkdir}/doc_out" --color -vW -b html -j auto