Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs/contents: use captions in the global toc #366

Draft
wants to merge 16 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 0 additions & 13 deletions docs/analog.rst

This file was deleted.

2 changes: 0 additions & 2 deletions docs/analog/bag.rst

This file was deleted.

2 changes: 0 additions & 2 deletions docs/analog/fasoc.rst

This file was deleted.

20 changes: 20 additions & 0 deletions docs/analog/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Analog Design
#############

.. TODO::
With Cadence Virtuoso

.. TODO::
With MAGIC

.. TODO::
With Klayout

.. TODO::
With Berkeley Analog Generator (BAG)

.. TODO::
With FASoC

.. TODO::
With your design flow?
2 changes: 0 additions & 2 deletions docs/analog/klayout.rst

This file was deleted.

2 changes: 0 additions & 2 deletions docs/analog/magic.rst

This file was deleted.

2 changes: 0 additions & 2 deletions docs/analog/new.rst

This file was deleted.

2 changes: 0 additions & 2 deletions docs/analog/virtuoso.rst

This file was deleted.

3 changes: 0 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -169,9 +169,6 @@
'github_url': 'https://github.com/google/skywater-pdk',
'repo_name': 'google/skywater-pdk',

'globaltoc_depth': 4,
'globaltoc_collapse': False,

# Hide the symbiflow links
'hide_symbiflow_links': True,
'license_url' : 'https://www.apache.org/licenses/LICENSE-2.0',
Expand Down
9 changes: 0 additions & 9 deletions docs/contents.rst

This file was deleted.

10 changes: 0 additions & 10 deletions docs/digital.rst

This file was deleted.

11 changes: 11 additions & 0 deletions docs/digital/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Digital Design
##############

.. TODO::
With Cadence Innovus

.. TODO::
With OpenROAD

.. TODO::
With your design flow?
2 changes: 0 additions & 2 deletions docs/digital/innovus.rst

This file was deleted.

2 changes: 0 additions & 2 deletions docs/digital/new.rst

This file was deleted.

2 changes: 0 additions & 2 deletions docs/digital/openroad.rst

This file was deleted.

110 changes: 74 additions & 36 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,31 +1,5 @@
.. include:: common.inc

.. toctree::
:hidden:

versioning
Current Status <status>
known_issues

Design Rules <rules>

contents

analog
digital
sim
verification

Python API <python-api/index>

previous
glossary

contributing
partners

references


Welcome to SkyWater SKY130 PDK's documentation!
===============================================
Expand All @@ -38,27 +12,91 @@ Welcome to SkyWater SKY130 PDK's documentation!
:alt: SkyWater PDK Logo Image.


.. _CurrentStatus:

Current Status - |current-status|
=================================

.. include:: status.rst
:start-after: current_status_text

Resources
=========
---------

The latest SkyWater SKY130 PDK design resources can be downloaded from the following repositories:

* `On Github @ google/skywater-pdk <https://github.com/google/skywater-pdk>`_
* `Google CodeSearch interface @ https://cs.opensource.google/skywater-pdk <https://cs.opensource.google/skywater-pdk>`_
* `foss-eda-tools.googlesource.com/skywater-pdk <https://foss-eda-tools.googlesource.com/skywater-pdk/>`_


Indices and tables
==================
------------------

* :ref:`glossary`
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


Table of contents
-----------------

.. toctree::
:maxdepth: -1

versioning
known_issues


.. toctree::
:caption: Process Design Rules
:name: rules
:maxdepth: -1

rules/background
rules/masks
rules/assumptions
rules/layers
rules/index
rules/methodologies/index
rules/rcx
rules/device-details
rules/errors


.. toctree::
:caption: PDK Contents
:name: pdk-contents
:maxdepth: -1

Libraries <contents/libraries>
File Types <contents/file_types>


.. toctree::
:caption: Design and Simulation
:name: analog
:maxdepth: -1

analog/index
digital/index
sim/index


.. toctree::
:caption: Physical & Design Verification
:name: verification
:maxdepth: -1

verification/index
verification/drc/index
verification/lvs/index
verification/pex/index


.. toctree::
:caption: Appendix
:maxdepth: -1

Python API <python-api/index>

previous
glossary

contributing
partners

references
28 changes: 0 additions & 28 deletions docs/rules.rst

This file was deleted.

3 changes: 0 additions & 3 deletions docs/rules/antenna.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
Antenna Rules
=============

Antenna rules specify the maximum allowed ratio of interconnect area exposed to plasma etch to active gate poly area that is electrically connected to it when the interconnect is etched. Interconnect areas exposed to plasma etch are:

* bottom areas of Licon, Mcon, Via, Via2
Expand Down
30 changes: 30 additions & 0 deletions docs/rules/summary.rst → docs/rules/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
Rules
#####

Summary of Key Periphery Rules
==============================

Expand Down Expand Up @@ -34,3 +37,30 @@ Manual merge means that features below min. space should be manually merged by d
:file: summary/table-f5-device-connectivity.csv
:header-rows: 1
:stub-columns: 1


Periphery
=========

.. include:: periphery.rst


WLCSP
=====

.. TODO: These should be formatted in the same way the periphery rules are.

.. csv-table:: Amkor WLCSP
:file: wlcsp/amkor.csv
:header-rows: 1
:stub-columns: 1

.. csv-table:: DECA WLCSP
:file: wlcsp/deca.csv
:header-rows: 1
:stub-columns: 1

Antenna Rules
=============

.. include:: antenna.rst
Loading