diff --git a/doc/conf.py b/doc/conf.py index c7098d099..3df95094a 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,3 +1,5 @@ +# pylint: disable=invalid-name, redefined-builtin, missing-module-docstring + # Configuration file for the Sphinx documentation builder. # # This file only contains a selection of the most common options. For a full @@ -46,7 +48,7 @@ "sphinx.ext.napoleon", "myst_parser", "breathe", -] + ] source_suffix = {".rst": "restructuredtext", ".md": "markdown"} @@ -86,7 +88,7 @@ "collapse_navigation": False, "navigation_depth": 4, "prev_next_buttons_location": None, # no navigation buttons -} + } # -- Doxygen integration with Breathe ----------------------------------------- @@ -109,7 +111,7 @@ subprocess.check_call( ["doxygen", "Doxyfile"], stdout=subprocess.PIPE, cwd=doc_dir, env=env -) + ) cpp_api_index_target = doc_dir / "cpp_api/api.rst" @@ -119,10 +121,10 @@ stdout=subprocess.PIPE, cwd=doc_dir, env=env, -) + ) if not cpp_api_index_target.exists(): - shutil.copyfile(doc_dir / "cpp_api.rst", cpp_api_index_target) + shutil.copyfile(doc_dir / "cpp_api.rst", cpp_api_index_target) print("Done with c++ API doc generation") @@ -144,7 +146,7 @@ "py_api", "../python", "*test_*.py", # exclude tests - ] -) + ] + ) print("Done with python API doc generation")