Fixing all warnings on the docs

google · Aug 8, 2022 · b21704f · b21704f
1 parent 6de3469
commit b21704f
Show file tree

Hide file tree

Showing 10 changed files with 36 additions and 37 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -14,6 +14,9 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+sphinx:
+  fail_on_warning: true
+
 name: gf180mu-pdk-docs
 channels:
 - defaults

diff --git a/Makefile b/Makefile
@@ -47,8 +47,7 @@ docs: build display
 
 .ONESHELL:
 install-theme:
-	@cd docs/
-	@rm -rf sphinx_f4pga_theme
+	@rm -rf sphinx_f4pga_theme docs/sphinx_f4pga_theme
 	@git clone $(theme_link)
 	@cd sphinx_f4pga_theme 
 	@python setup.py install 

diff --git a/docs/IPs/ips.rst b/docs/IPs/ips.rst
@@ -1,7 +1,7 @@
 
-************
-IPs / Macros
-************
+***************
+IPs and Macros
+***************
 
 .. toctree::
     :maxdepth: 3

diff --git a/docs/Makefile b/docs/Makefile
@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2022 Efabless Corporation
+# Copyright 2022 GlobalFoundries PDK Authors
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/docs/analog/model_parameters/LV/LV_2_5.rst b/docs/analog/model_parameters/LV/LV_2_5.rst
@@ -21,14 +21,14 @@ where
    Vth0 is the measured or simulated threshold voltage obtained using the max Gm method at Vd = 0.05V. For 6.0V native NMOS, Vth0 is measured and simulated at Vd=0.1V. Vth1 is the simulated threshold voltage obtained using the BSIM equation. These two values may have a difference.
 
 2.5.1 nfet_03v3 and pfet_03v3 (3.3V)
-..................................
+........................................
 
 .. csv-table::
    :file: tables_clear/19_mos_3p3.csv
 
 
 2.5.2 NMOS 3p3 SAB PMOS 3p3 SAB
-...............................
+.....................................
 
 .. csv-table::
    :file: tables_clear/20_MOS_3p3_SAB.csv
@@ -40,7 +40,7 @@ where
    - pfet_03v3_dss SAB Length on Drain side SAB DOP: 1.78um, Source Side SAB SOP: 0.48um
 
 2.5.3 nfet_06v0 and pfet_06v0 (6V)
-................................
+......................................
 
 .. csv-table::
    :file: tables_clear/21_mos_6p0.csv
@@ -52,7 +52,7 @@ where
    - pfet_06v0_dss Length of SAB on Drain side : 2.78um, Length of SAB on Source side: 0.28um
 
 2.5.4 nfet_06v0 and pfet_06v0 (5V)
-................................
+......................................
 
 .. csv-table::
    :file: tables_clear/22_mos_6p0_1.csv

diff --git a/docs/analog/model_parameters/LV/LV_8_1.rst b/docs/analog/model_parameters/LV/LV_8_1.rst
@@ -2,7 +2,7 @@
 ===========
 
 8.1.1 nfet_03v3 (3.3V)
-.....................
+............................
 
 8.1.1.1 CV - Characteristics
 """"""""""""""""""""""""""""
@@ -89,7 +89,7 @@
    :alt: I/f Noise - Characteristics
 
 8.1.2 pfet_03v3 (3.3V)
-.....................
+..........................
 
 8.1.2.1 CV - Characteristics
 """"""""""""""""""""""""""""
@@ -176,7 +176,7 @@
    :alt: I/f Noise - Characteristics
 
 8.1.3 nfet_06v0 (6.0V)
-.....................
+..........................
 
 8.1.3.1 CV - Characteristics
 """"""""""""""""""""""""""""
@@ -217,7 +217,7 @@
    :alt: I/f Noise - Characteristics
 
 8.1.4 pfet_06v0 (6.0V)
-.....................
+..........................
 
 8.1.4.1 CV - Characteristics
 """"""""""""""""""""""""""""
@@ -264,7 +264,7 @@
    :alt: I/f Noise - Characteristics
 
 8.1.5 nfet_06v0_nvt (6.0V)
-.........................
+..............................
 
 8.1.5.1 IV - Characteristics
 """"""""""""""""""""""""""""

diff --git a/docs/conf.py b/docs/conf.py
@@ -31,8 +31,9 @@
 import docutils
 import os
 import re
-# import sys
+import sys
 # sys.path.insert(0, os.path.abspath('.'))
+sys.path.append(os.path.abspath('open-source-pdks/docs'))
 
 
 # -- Project information -----------------------------------------------------
@@ -59,6 +60,11 @@
     'sphinx.ext.mathjax',
     'sphinx.ext.napoleon',
     'sphinx.ext.todo',
+    'sphinx_pdk_roles',
+]
+
+suppress_warnings = [
+    'autosectionlabel.*',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -106,11 +112,6 @@
 # Usually you set "language" from the command line for these cases.
 language = 'en'
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
-
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
@@ -120,6 +121,11 @@
     'venv',
     'Thumbs.db',
     '.DS_Store',
+    '.vscode',
+    'IPs/**/code-of-conduct.rst',
+    'IPs/**/contributing.rst',
+    'digital/**/code-of-conduct.rst',
+    'digital/**/contributing.rst',
 ]
 
 # The name of the Pygments (syntax highlighting) style to use.
@@ -169,15 +175,15 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['_static','open-source-pdks/docs/_static']
 
 
 # -- Options for manual page output ------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('gf180mcu-pdk', 'GlobalFoundries 0.18UM PDK Documentation',
+    ('gf180mcu-pdk', 'GlobalFoundries 180nm PDK Documentation',
      [author], 1)
 ]
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,7 +3,6 @@
 Welcome to GlobalFoundries 0.18UM 3.3V/(5V)6V MCU PDK's documentation!
 ****************************************************************************
 
-.. include:: common.inc
 
 .. toctree::
     :hidden:
@@ -13,7 +12,7 @@ Welcome to GlobalFoundries 0.18UM 3.3V/(5V)6V MCU PDK's documentation!
     IPs/ips
     physical_verification/design_man
 
-    open-source-pdks/index
+    open-source-pdks/docs/index
 
 .. warning::
     This documentation is currently a **work in progress**.
@@ -22,11 +21,5 @@ Welcome to GlobalFoundries 0.18UM 3.3V/(5V)6V MCU PDK's documentation!
     :align: center
     :alt: GlobalFoundries PDK Logo Image.
 
-
-Current Status -- |current-status|
-==================================
-
-.. include:: status
-    :start-after: current_status_text
-
+.. include:: status.rst
 
diff --git a/docs/open-source-pdks b/docs/open-source-pdks
@@ -1 +1 @@
-../third_party/open-source-pdks/docs
+../third_party/open-source-pdks
diff --git a/docs/status.rst b/docs/status.rst
@@ -1,9 +1,7 @@
-.. include:: common.inc
-
 Current Status -- |current-status|
 ==================================
 
-.. current_status_text
+.. include:: common.inc
 
 .. warning::
    Google and GlobalFoundries are currently treating the current content as an **experimental preview** / **alpha release**.
@@ -12,5 +10,5 @@ While the GF180 process node and the PDK from which this open source release was
 
 Google, GlobalFoundries and our partners are currently doing internal validation and test designs, including silicon validation or the released data and plan to publish these results.
 
-The PDK will be tagged with a production version when ready to do production design, see the ":ref:`Versioning Information`" section for a full description of the version numbering scheme.
+The PDK will be tagged with a production version when ready to do production design, see the ":ref:`Versioning`" section for a full description of the version numbering scheme.