Commit Graph

111 Commits

Author SHA1 Message Date
Tim 'mithro' Ansell 3c78bc9c61 Install the skywater-pdk Python library into Sphinx environment.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2021-11-01 09:42:51 -07:00
Tim 'mithro' Ansell 8da028387b Remove conda-forge from environment channels.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2021-11-01 09:42:51 -07:00
Tim 'mithro' Ansell f198a3337b Remove symbolator requirement.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2021-11-01 09:42:51 -07:00
Tim 'mithro' Ansell 0512ef6890 docs: Fix nfet_05v0_nvt cell name.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2021-10-30 15:53:43 -07:00
Ethan Mahintorabi 80cf294140
Update documentation on build space from sp to bd
It was decided that sp is too close to single port, and should be renamed bd to reference the build space.

Closes #338
2021-09-28 15:07:13 -07:00
Mohamed Gaber cc1db3eb70 Work Around pypa/pip#10237 2021-08-05 17:32:19 +02:00
Tim Ansell 3d7617a1ac
Merge pull request #203 from antmicro/160-fix-sphinx-warnings
Removed duplicated keys from previous.rst
2020-11-29 10:10:43 -08:00
Tim Ansell f1558ff0ba
Merge pull request #257 from antmicro/161-fix-footnote-warnings
Fix footnote warnings - table footnotes included in parent documents
2020-11-29 09:58:52 -08:00
Wojciech Gryncewicz 2fada8d9e1 docs: Fixed a typo and table symbols explanation layout
Signed-off-by: Wojciech Gryncewicz <wgryncewicz@antmicro.com>
2020-11-28 14:45:03 -08:00
Wojciech Gryncewicz 1cadc862a3 docs: Suppressed footnote warnings for included -key.rst files
Signed-off-by: Wojciech Gryncewicz <wgryncewicz@antmicro.com>
2020-11-28 14:44:52 -08:00
Tim 'mithro' Ansell f2fccd58c7 infra: Also convert the documentation to use `make-env`.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-11-24 08:16:20 -08:00
Tim Ansell ca58d58c07
Merge pull request #229 from antmicro/137-improve-equations-and-fractions
Added script converting rst subscript and equations to math.
2020-11-18 05:31:45 -08:00
Tim Ansell f7932e137b
Merge pull request #227 from antmicro/105_add_units_to_rules
Add units to rules
2020-11-17 13:49:31 -08:00
Wojciech Gryncewicz 9039be3779 Unit column generated for periphery.csv and resulting tables 2020-11-16 17:13:49 +01:00
Wojciech Gryncewicz 1382e726c3 Subscript and equation formatting changed to math. 2020-11-16 17:05:48 +01:00
Piotr Katarzynski 2c176786f1
Update CodeSearch link in docs/index.rst
Co-authored-by: Tim Ansell <me@mith.ro>
2020-11-11 18:37:58 +01:00
Piotr Katarzynski 393c8176b8
Update GitHub link in docs/index.rst
Co-authored-by: Tim Ansell <me@mith.ro>
2020-11-11 18:37:27 +01:00
Piotr Katarzynski 24204d3f9a Add repository links to the main page
Signed-off-by: Piotr Katarzynski <pkatarzynski@antmicro.com>
2020-11-09 16:25:53 +01:00
diadatp 2566c6e338 Fix footnote issue in table 4 2020-11-08 00:17:18 +05:30
Tim Ansell 6fd025ed33
Merge pull request #211 from antmicro/enable_no_conda
Enable not using conda for docs build
2020-11-06 14:00:04 -08:00
Michael Gielda e6336c5038 Enable not using conda for docs build
Signed-off-by: Michael Gielda <mgielda@antmicro.com>
2020-11-06 15:46:58 +01:00
Wojciech Gryncewicz b80f532bbc removed total table width field from periphery table rst template
Signed-off-by: Wojciech Gryncewicz <wgryncewicz@antmicro.com>
2020-11-06 14:11:41 +01:00
Wojciech Gryncewicz 93b039d1fc csv description line break handling
Signed-off-by: Wojciech Gryncewicz <wgryncewicz@antmicro.com>

periphery csv description line break handling

Signed-off-by: Wojciech Gryncewicz <wgryncewicz@antmicro.com>

Reduction of one item lists

Signed-off-by: Wojciech Gryncewicz <wgryncewicz@antmicro.com>
2020-11-05 15:38:28 +01:00
Wojciech Gryncewicz 1e16594fb2 Removed duplicated keys from previous.rst
Signed-off-by: Wojciech Gryncewicz <wgryncewicz@antmicro.com>
2020-11-03 16:24:36 +01:00
Wojciech Gryncewicz e3f231464a Added license link in the footer 2020-11-03 15:02:23 +01:00
Wanderrful b0f48f052e Remove placeholder 2020-10-16 08:24:47 -05:00
Wanderrful 8f7ec915a2 Fix POSIX file paths 2020-10-16 08:24:47 -05:00
Wanderrful 4c51522684 Apply changes to generated CSV and RST files 2020-10-16 08:24:47 -05:00
Wanderrful 87d78ca78c Remove rows with "Section" in the first column 2020-10-16 08:22:26 -05:00
Wanderrful c0add3b9ca Specify UTF-8 encoding for all open() calls 2020-10-16 08:22:26 -05:00
Wanderrful 68a230db4c Apply changes to generated CSV and RST files 2020-10-16 08:22:26 -05:00
Wanderrful ec448b284d Fix #75 - final rule was excluded incorrectly 2020-10-16 08:22:26 -05:00
Tim 'mithro' Ansell f7d23040ac sky130_fd_io: Initial documentation only release.
The SKY130 IO cells is a toolkit IP. It contains all the cells and
primitives required to construct an I/O ring in the SKY130 technology.

This sky130_fd_io library contained in this document covers different
kinds of I/O cells,

 * a general purpose I/O (`sky130_fd_io__gpio`), and
 * a special I/O (`sky130_fd_io__sio`),
 * a reference generator (`sky130_fd_io__refgen`) for providing voltage
   references to the `sky130_fd_io__sio`, and
 * Power and Ground (PG) cells that make up the I/O ring.

Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-10-13 14:23:56 -07:00
Adrian Freed a651b17f5a
Corrected minor typos
Changed Sky30 to SKY130
Changed S130 to SKY130
Removed a dangling reference to a table
Clarified size comparison of hvl library
2020-10-12 11:24:12 -07:00
Tim 'mithro' Ansell 4abbce3cf3 docs: Adding summary of foundry provided cells.
Provides a little bit of summary information on each of the foundry
provided standard cells.

Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-10-12 04:28:33 -07:00
Tim 'mithro' Ansell b79a54e235 docs: Renaming so docs match `sky130_fd_pr` cell names.
* Make the directory names consistent with cell names.
 * Add `:model:` and `:cell:` around object names.
 * Small other cleanups.

Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-30 17:46:39 -07:00
Tim 'mithro' Ansell 0a35656db1 docs: Improve sort order of device-details page.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-30 17:27:47 -07:00
Tim 'mithro' Ansell a335a40331 docs: Fixing the sign on the Low Voltage PMOS FETs.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-30 17:27:47 -07:00
Tim 'mithro' Ansell 7738f321ff docs: Split the 3V and 5V native NMOS FETs.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-30 17:27:47 -07:00
Tim 'mithro' Ansell 788451177d docs: Adding details for various supported devices.
Each type of device includes;
 - General device description
 - Details about the spice model and operating conditions.
 - Images of the symbols for the device.
 - Image showing the cross-section of the device.

The devices included are;
 - Bipolar (NPN)
 - Bipolar (PNP)
 - MiM Capacitor
 - Vertical Parallel Plate (VPP) capacitors
 - SONOS cells
 - SRAM cells
 - Diodes
 - 11V/16V NMOS FET
 - 1.8V NMOS FET
 - 1.8V low-VT NMOS FET
 - 20V NMOS FET
 - 20V isolated NMOS FET
 - 20V native NMOS FET
 - 20V NMOS zero-VT FET
 - 3.0V and 5.0V native NMOS FET
 - 5.0V/10.5V NMOS FET
 - NMOS ESD FET
 - 10V/16V PMOS FET
 - 1.8V PMOS FET
 - 1.8V high-VT PMOS FET
 - 1.8V low-VT PMOS FET
 - 20V PMOS FET
 - 5.0V/10.5V PMOS FET
 - Generic Resistors
 - P- poly precision resistors
 - P+ poly precision resistors
 - Varactors

Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>

Temp.
2020-09-30 17:27:47 -07:00
Tim 'mithro' Ansell fa5e348b4a docs: Makefile for generating a combined device-details.rst file.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-30 17:27:47 -07:00
Tim 'mithro' Ansell 0fccbdc534 docs: Adding `cell` role to Sphinx.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-30 17:27:39 -07:00
Tim 'mithro' Ansell 0de3fb356b docs: Adding useful rstdoc tool.
- `rstlisttable` - Convert RST grid tables to list-tables
 - `rstreflow` - Reflow paragraphs and tables
 - `rstretable` -Transforms list tables to grid tables

Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-30 12:07:57 -07:00
Tim 'mithro' Ansell bd804a00c1 docs: Reworking favicon.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-24 17:29:17 -07:00
Tim 'mithro' Ansell 012ecba3a1 docs: Adding skywater-favicon.png file.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-24 17:06:45 -07:00
interfect caabe665e2
Fix typo: "an approximations"
The values should probably be described just as "approximations".
2020-09-20 13:19:38 -07:00
Tim 'mithro' Ansell 94015f5cc6 docs: Fix html_context values.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-19 14:37:28 -07:00
Tim 'mithro' Ansell d19cd14395 docs: Fix name in the extensions list.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-19 14:36:30 -07:00
Tim 'mithro' Ansell 73fd000ff4 docs: Fixing requirements.txt
* Install sphinx-verilog-domain.
 * Update for the sphinxcontrib-verilog-diagrams name change.
 * Use the SymbiFlow version of Symbolator.

Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-19 14:28:08 -07:00
Tim 'mithro' Ansell 5113b97155 docs: Fixing capacitance / resistance CSV files.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-14 12:30:16 -07:00