Issue#32: Fixing documentation warnings and errors.

jeremiah-c-leary · Mar 1, 2024 · 973758a · 973758a
1 parent fce1d18
commit 973758a
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 28 deletions.
diff --git 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
@@ -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/...ce/vendors/mentor_graphics/questa_cdc.rst → ...mentor_graphics/questa_cdc/cdc_detail.rst b/...ce/vendors/mentor_graphics/questa_cdc.rst → ...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
@@ -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
@@ -0,0 +1,10 @@
+Quasta CDC
+~~~~~~~~~~
+
+Questa CDC provides several reports which can be parsed.
+
+.. toctree::
+   :maxdepth: 2
+
+   cdc_run.rst
+   cdc_detail.rst