docs: Cleanup a bunch of sphinx warnings.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
diff --git a/docs/conf.py b/docs/conf.py
index 4960e95..31fb98f 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -308,6 +308,7 @@
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
+
# -- Extension configuration -------------------------------------------------
# -- Options for todo extension ----------------------------------------------
@@ -364,6 +365,7 @@
def setup(app):
app.add_css_file('extra.css')
+ add_role(app, 'cell_name')
add_role(app, 'lib_process')
add_role(app, 'lib_src')
add_role(app, 'lib_type')
diff --git a/docs/contents/file_types.rst b/docs/contents/file_types.rst
index 4629613..840d1a2 100644
--- a/docs/contents/file_types.rst
+++ b/docs/contents/file_types.rst
@@ -23,7 +23,7 @@
| Macros | | | | | GDS data | |
+------------------------------+-------------------------------------------+-----------------+--------+------------------------+-----------------+--------------------------------------------------------------------------------------------------------+
| Timing Files | Describes pin-to-pin timing | ? | Ready | Liberty | Generated from | ? |
-| | | | | | JSON data | ? |
+| | | | | | JSON data | |
+------------------------------+-------------------------------------------+-----------------+--------+------------------------+-----------------+-------------------+--------------+-------------------------+-------------------------------------------+
| Netlists | Transistor level circuit description | Ngspice | Ready | Ngspice or CDL | ? | ? | ? | OpenAccess? | Generated from spice files |
+------------------------------+-------------------------------------------+-----------------+--------+------------------------+-----------------+-------------------+--------------+-------------------------+-------------------------------------------+
diff --git a/docs/contents/libraries.rst b/docs/contents/libraries.rst
index 97c1dd4..595a606 100644
--- a/docs/contents/libraries.rst
+++ b/docs/contents/libraries.rst
@@ -43,10 +43,6 @@
- The :lib_name:`Library Name` is an optional short abbreviated name used when there are multiple libraries of a given type released from a single :lib_src:`library source`. If only one library of a given type is going to ever be released, this can be left out.
-
-.. include:: versioning.rst
-
-
Creating New Libraries
----------------------
@@ -56,9 +52,13 @@
- TODO: Finish the criteria.
+.. _sky130-lib-primitives:
+
:lib_type:`Primitive` Libraries
-------------------------------
+.. _sky130-lib-primitives-foundry:
+
:lib_src:`Foundry` provided
~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -71,11 +71,15 @@
libraries/sky130_fd_pr_*/README
+.. _sky130-lib-standardcells:
+
:lib_type:`Digital Standard Cell` Libraries
-------------------------------------------
-:lib_src:`Foundry` provided
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. _sky130-lib-standardcells-foundry:
+
+:lib_src:`Foundry` provided :lib_type:`Digital Standard Cell` Libraries
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. toctree::
:glob:
@@ -84,9 +88,10 @@
libraries/sky130_fd_sc_*/README
+.. _sky130-lib-standardcells-thirdparty:
-:lib_src:`Third party` provided
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+:lib_src:`Third party` provided :lib_type:`Digital Standard Cell` Libraries
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
@@ -94,14 +99,17 @@
libraries/sky130_osu_sc/README
+.. _sky130-lib-buildspace:
:lib_type:`Build Space` Libraries
---------------------------------
The SKY130 currently offers two :lib_type:`build space` libraries. Build space libraries are designed to be used with technologies like memory compilers and built into larger macros. The provided libraries have specially crafted design rules to enable higher density compared to other libraries.
-:lib_src:`Foundry` provided
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. _sky130-lib-buildspace-foundry:
+
+:lib_src:`Foundry` provided :lib_type:`Build Space` Libraries
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. toctree::
:glob:
@@ -111,12 +119,15 @@
libraries/sky130_fd_sp_*/README
+.. _sky130-lib-io:
:lib_type:`IO and Periphery` Libraries
--------------------------------------
-:lib_src:`Foundry` provided
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. _sky130-lib-io-foundry:
+
+:lib_src:`Foundry` provided :lib_type:`IO and Periphery` Libraries
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
@@ -124,13 +135,14 @@
libraries/sky130_fd_io/README
+.. _sky130-lib-io-thirdparty:
-:lib_src:`Third party` provided
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+:lib_src:`Third party` provided :lib_type:`IO and Periphery` Libraries
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
- :name: sky130-lib-thirdparty-sc
+ :name: sky130-lib-thirdparty-io
libraries/sky130_ef_io/README
diff --git a/docs/known_issues.rst b/docs/known_issues.rst
index d7d1204..d6af494 100644
--- a/docs/known_issues.rst
+++ b/docs/known_issues.rst
@@ -19,8 +19,8 @@
The current cell datasheets only include basic information about the cell. These datasheets will be continuously updated with new information as the generator is improved.
-PDK Contents
-------------
+PDK Contents Issues
+-------------------
Tooling Compatibility
~~~~~~~~~~~~~~~~~~~~~
