From 973758ab4685c90f1313e65a2c798613aa1a7f7a Mon Sep 17 00:00:00 2001 From: Jeremiah Leary Date: Fri, 1 Mar 2024 07:16:59 -0600 Subject: [PATCH] Issue#32: Fixing documentation warnings and errors. --- docs/source/conf.py | 4 ++-- .../mentor_graphics/mentor_graphics.rst | 9 +++++--- .../cdc_detail.rst} | 23 ------------------- .../mentor_graphics/questa_cdc/cdc_run.rst | 17 ++++++++++++++ .../mentor_graphics/questa_cdc/questa_cdc.rst | 10 ++++++++ 5 files changed, 35 insertions(+), 28 deletions(-) rename docs/source/vendors/mentor_graphics/{questa_cdc.rst => questa_cdc/cdc_detail.rst} (70%) create mode 100644 docs/source/vendors/mentor_graphics/questa_cdc/cdc_run.rst create mode 100644 docs/source/vendors/mentor_graphics/questa_cdc/questa_cdc.rst diff --git a/docs/source/conf.py b/docs/source/conf.py index 4aafb93..7c76b47 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -66,14 +66,14 @@ release = str(elfws.version.version) -language = None +language = 'en' pygments_style = 'sphinx' html_theme_options = { 'logo_only': False, 'display_version': True, - 'prev_next_bottons_location': 'bottom', +# 'prev_next_bottons_location': 'bottom', 'style_external_links': False, 'vcs_pageview_mode': '', # 'style_nav_header_background': 'white', diff --git a/docs/source/vendors/mentor_graphics/mentor_graphics.rst b/docs/source/vendors/mentor_graphics/mentor_graphics.rst index 07393f7..c4df2ea 100644 --- a/docs/source/vendors/mentor_graphics/mentor_graphics.rst +++ b/docs/source/vendors/mentor_graphics/mentor_graphics.rst @@ -1,7 +1,10 @@ Mentor Graphics --------------- -.. include:: precision.rst -.. include:: questa_lint.rst -.. include:: questa_cdc.rst +.. toctree:: + :maxdepth: 2 + + precision.rst + questa_lint.rst + questa_cdc/questa_cdc.rst diff --git a/docs/source/vendors/mentor_graphics/questa_cdc.rst b/docs/source/vendors/mentor_graphics/questa_cdc/cdc_detail.rst similarity index 70% rename from docs/source/vendors/mentor_graphics/questa_cdc.rst rename to docs/source/vendors/mentor_graphics/questa_cdc/cdc_detail.rst index 66c593d..c99ecb4 100644 --- a/docs/source/vendors/mentor_graphics/questa_cdc.rst +++ b/docs/source/vendors/mentor_graphics/questa_cdc/cdc_detail.rst @@ -1,26 +1,3 @@ -Quasta CDC -~~~~~~~~~~ - -Questa CDC provides several reports which can be parsed. - -cdc_run.log -=========== - -The cdc_run.log file reports violations, cautions, and evaluations in addition to run time errors and warnings. - -CDC Results -^^^^^^^^^^^ - -This section reports the CDC crossings and whether they are Violations, Cautions, and Evaluations. -The reporting is divided into reporting the number of types of crossings and then the details of the crossing. -Only the number of types of crossings will be reported for Violations, Cautions, and Evaluations. - -Message Summary -^^^^^^^^^^^^^^^ - -This section reports errors and warnings encountered while running the tool. -There should not be any Errors or Warnings in this section. - cdc_detail.rpt ============== diff --git a/docs/source/vendors/mentor_graphics/questa_cdc/cdc_run.rst b/docs/source/vendors/mentor_graphics/questa_cdc/cdc_run.rst new file mode 100644 index 0000000..f71740e --- /dev/null +++ b/docs/source/vendors/mentor_graphics/questa_cdc/cdc_run.rst @@ -0,0 +1,17 @@ +cdc_run.log +=========== + +The cdc_run.log file reports violations, cautions, and evaluations in addition to run time errors and warnings. + +CDC Results +^^^^^^^^^^^ + +This section reports the CDC crossings and whether they are Violations, Cautions, and Evaluations. +The reporting is divided into reporting the number of types of crossings and then the details of the crossing. +Only the number of types of crossings will be reported for Violations, Cautions, and Evaluations. + +Message Summary +^^^^^^^^^^^^^^^ + +This section reports errors and warnings encountered while running the tool. +There should not be any Errors or Warnings in this section. diff --git a/docs/source/vendors/mentor_graphics/questa_cdc/questa_cdc.rst b/docs/source/vendors/mentor_graphics/questa_cdc/questa_cdc.rst new file mode 100644 index 0000000..ee7a5ca --- /dev/null +++ b/docs/source/vendors/mentor_graphics/questa_cdc/questa_cdc.rst @@ -0,0 +1,10 @@ +Quasta CDC +~~~~~~~~~~ + +Questa CDC provides several reports which can be parsed. + +.. toctree:: + :maxdepth: 2 + + cdc_run.rst + cdc_detail.rst