Commit Graph

137 Commits

Author SHA1 Message Date
Unai Martinez-Corral 7da20f0512 docs/analog: reorganize
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-08-21 02:27:33 +02:00
Unai Martinez-Corral 608eb3f641 docs/sim: reorganize
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-08-21 02:27:33 +02:00
Unai Martinez-Corral 50e5e099b0 docs/verification: reorganize
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-08-21 02:27:33 +02:00
Unai Martinez-Corral edf2c4ece9 docs/rules: reorganize
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-08-21 02:27:33 +02:00
Unai Martinez-Corral 7b1bf00faa docs: make toctree visible
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-08-21 02:27:31 +02:00
Unai Martinez-Corral 1efec35671 docs: merge status into versioning
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-08-21 02:27:10 +02:00
Unai Martinez-Corral 97b9969501 docs: add Appendix caption
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-08-21 02:27:10 +02:00
Unai Martinez-Corral 3eb838640c docs/verification: use toctree with caption
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-08-21 02:27:10 +02:00
Unai Martinez-Corral 68583ff810 docs/sim: use toctree with caption
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-08-21 02:27:09 +02:00
Unai Martinez-Corral 56cd9d707b docs/digital: use toctree with caption
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-08-21 02:27:09 +02:00
Unai Martinez-Corral 307e0038a2 docs/analog: use toctree with caption
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-08-21 02:27:09 +02:00
Unai Martinez-Corral 90d6565314 docs/rules: use toctree with caption
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-08-21 02:27:09 +02:00
Unai Martinez-Corral 129c174127 docs/contents: use toctree with caption
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-08-21 02:27:06 +02:00
Unai Martinez-Corral 7900f43bf7 docs/conf: rm globaltoc collapse and depth
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-08-21 02:26:40 +02:00
Unai Martinez-Corral e06e29c954 docs: add References through BibTeX
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-08-21 02:12:40 +02:00
Tim 'mithro' Ansell 60fe154d3b
Merge pull request #384 from mithro/sphinx-conf-fix
Fixing the announcement link in top level bar.
2022-07-20 07:34:33 -07:00
Tim 'mithro' Ansell e0fc892c1c Fixing the announcement link in top level bar.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2022-07-12 19:27:38 -07:00
Johan Euphrosine 3fbe6e5b23
Merge pull request #383 from mithro/sphinx-conf-fix
Fixing Sphinx config for GitHub.
2022-07-12 20:09:57 -04:00
Tim 'mithro' Ansell 99274f31eb Fixing Sphinx config for GitHub.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2022-07-12 16:59:42 -07:00
Unai Martinez-Corral 5d0ba2fb8b docs/environment: do not require yosys
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-04-20 09:02:26 +02:00
Tim 'mithro' Ansell 73e9c8402d docs: Include toc in sidebar.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2021-11-02 08:19:20 -07:00
Tim 'mithro' Ansell b57bd58ad2 docs: Remove unneeded comment in Sphinx config.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2021-11-02 08:18:21 -07:00
Tim 'mithro' Ansell 1a47a4f774 Adding more top level links.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2021-11-01 11:52:11 -07:00
Tim 'mithro' Ansell 3431f934a9 Small tweaks to documentation configuration.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2021-11-01 09:58:34 -07:00
Tim 'mithro' Ansell b72fa4b714 Updating the Sphinx configuration for new theme.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2021-11-01 09:42:51 -07:00
Tim 'mithro' Ansell 909d06d4f6 Update to new Sphinx theme.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2021-11-01 09:42:51 -07:00
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