riscv
/
skywater-pdk
mirror of https://github.com/google/skywater-pdk.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Cleanup a bunch of sphinx warnings. 

Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
This commit is contained in:
Tim 'mithro' Ansell 2020-06-25 19:24:22 -07:00
parent 1fc041f575
commit acd53975a2
4 changed files with 32 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/conf.py
View File

@ -308,6 +308,7 @@ epub_title = project
# 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 add_role(app, new_role_name):
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')

2
docs/contents/file_types.rst
View File

@ -23,7 +23,7 @@ File Types
| 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 |
+------------------------------+-------------------------------------------+-----------------+--------+------------------------+-----------------+-------------------+--------------+-------------------------+-------------------------------------------+

42
docs/contents/libraries.rst
View File

@ -43,10 +43,6 @@ All sections are **lower case** and separated by an **underscore**. The sections
- 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 @@ Third party developers are encourage to create new and interesting libraries for
- TODO: Finish the criteria.
.. _sky130-lib-primitives:
:lib_type:`Primitive` Libraries
-------------------------------
.. _sky130-lib-primitives-foundry:
:lib_src:`Foundry` provided
~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -71,11 +71,15 @@ Third party developers are encourage to create new and interesting libraries for
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 @@ Third party developers are encourage to create new and interesting libraries for
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 @@ Third party developers are encourage to create new and interesting libraries for
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 @@ The SKY130 currently offers two :lib_type:`build space` libraries. Build space l
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 @@ The SKY130 currently offers two :lib_type:`build space` libraries. Build space l
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

4
docs/known_issues.rst
View File

@ -19,8 +19,8 @@ A number of sections in the documentation still have pending TODO items. These w
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
~~~~~~~~~~~~~~~~~~~~~