diff --git a/Makefile.in b/Makefile.in index 0e0d7607a..03d032718 100644 --- a/Makefile.in +++ b/Makefile.in @@ -479,9 +479,8 @@ PY_PROGRAMS = \ examples/xml_py/vl_file_copy \ examples/xml_py/vl_hier_graph \ docs/guide/conf.py \ - docs/guide/vl_sphinx_extract \ - docs/guide/vl_sphinx_extract \ - docs/guide/vl_doxygen_filter \ + docs/bin/vl_sphinx_extract \ + docs/bin/vl_sphinx_fix \ src/astgen \ src/bisonpre \ src/config_rev \ diff --git a/docs/bin/vl_sphinx_extract b/docs/bin/vl_sphinx_extract index 068ad8b35..1b2c27d07 100755 --- a/docs/bin/vl_sphinx_extract +++ b/docs/bin/vl_sphinx_extract @@ -1,5 +1,5 @@ #!/usr/bin/env python3 -# pylint: disable=C0112,C0114,C0116,C0301,R0903 +# pylint: disable=C0112,C0114,C0115,C0116,C0301,R0201,R0903 # -*- Python -*- See copyright, etc below ###################################################################### @@ -8,6 +8,7 @@ import re ####################################################################### + class VlSphinxExtract: debug = 0 SkipBasenames = {} diff --git a/docs/bin/vl_sphinx_fix b/docs/bin/vl_sphinx_fix index cedbc0d63..ed6d06107 100755 --- a/docs/bin/vl_sphinx_fix +++ b/docs/bin/vl_sphinx_fix @@ -1,5 +1,5 @@ #!/usr/bin/env python3 -# pylint: disable=C0112,C0114,C0116,C0301,R0903 +# pylint: disable=C0112,C0114,C0115,C0116,C0301,R0903 # -*- Python -*- See copyright, etc below ###################################################################### diff --git a/docs/guide/conf.py b/docs/guide/conf.py index 1d30f1d51..060d7a106 100644 --- a/docs/guide/conf.py +++ b/docs/guide/conf.py @@ -1,4 +1,4 @@ -# pylint: disable=E402 +# pylint: disable=C0103,C0114,C0116,E0402,W0622 # # Configuration file for Verilator's Sphinx documentation builder. # SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 @@ -12,11 +12,10 @@ from datetime import datetime import os import re -import shutil import sys sys.path.insert(0, os.path.abspath('./_ext')) -import sphinx_rtd_theme +import sphinx_rtd_theme # pylint: disable=wrong-import-position, def get_vlt_version(): @@ -94,7 +93,7 @@ today_fmt = datetime.now().strftime("%F") # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True -# TODO could use this for internals<->guide references +# Could use this for internals<->guide references # intersphinx_mapping = { 'sphinx': ('https://sphinx-doc.org/', None), } # ---------------------------------------------------------------------- @@ -208,7 +207,7 @@ spelling_ignore_contributor_names = True # ---------------------------------------------------------------------- # -- Options for doxygen -#if shutil.which("doxygen"): +# if shutil.which("doxygen"): # breathe_projects = { # "verilated": "../_build/doxygen/verilated/xml", # } diff --git a/docs/guide/warnings.rst b/docs/guide/warnings.rst index 3e0840c89..ee76aeece 100644 --- a/docs/guide/warnings.rst +++ b/docs/guide/warnings.rst @@ -809,7 +809,7 @@ List Of Warnings This is considered bad style, as the consumer of a given signal may be unaware of the inconsistent clocking, causing clock domain crossing - bugs. + or timing bugs. Faulty example: