The-OpenROAD-Project/OpenROAD
1
0
Fork 0
mirror of https://github.com/The-OpenROAD-Project/OpenROAD.git synced 2026-06-02 01:08:34 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity
39,317 Commits 6 Branches 8 Tags
dependabot/github_actions/actions/setup-java-5
Commit Graph

45 Commits

Author SHA1 Message Date
Matt Liberty
08138fb64f Merge pull request #9866 from sparsh-karna/odb/grammar-railroad-diagrams 
odb: add LEFDEF grammar railroad diagram documentation
 2026-03-30 21:11:11 +00:00
Austin Rovinski
4aab880300 ram: Create initial README.md 
Signed-off-by: Austin Rovinski <rovinski@users.noreply.github.com>
 2026-03-23 02:43:45 -04:00
Sparsh Karna
220c00bbab odb: add LEF/DEF grammar railroad diagram docs 
Add SVG railroad diagrams generated directly from lef.y and def.y,
a Python script to regenerate them, Markdown documentation that
embeds the diagrams, and a GitHub Actions workflow that opens a PR
whenever a grammar file changes.

Files added:
- src/odb/doc/generate_railroad_diagrams.py  — converts .y → EBNF →
  individual SVG files using ebnf-convert and rr (downloaded from
  Maven Central on first use; not committed).
- src/odb/doc/images/lef/  — 246 SVGs generated from lef.y
- src/odb/doc/images/def/  — 276 SVGs generated from def.y
- src/odb/doc/LEF_Grammar.md  — documentation with embedded diagrams
- src/odb/doc/DEF_Grammar.md  — documentation with embedded diagrams
- src/odb/doc/.gitignore  — excludes tools/ and intermediate files
- .github/workflows/github-actions-update-grammar-railroad-diagrams.yml
  — auto-regenerates and opens a PR on grammar changes

Resolves #2488

Signed-off-by: Sparsh Karna <sparsh2005karna@gmail.com>
 2026-03-21 16:16:28 +05:30
Krzysztof Bieganski
cbb9e28df0 cgt: Clock gating 
Signed-off-by: Krzysztof Bieganski <kbieganski@antmicro.com>
 2025-03-28 14:04:15 +01:00
Matt Liberty
bee7f1d30f Various places: remove mpl2 vestiges 
Signed-off-by: Matt Liberty <mliberty@precisioninno.com>
 2025-03-17 03:47:13 +00:00
Peter Gadfort
937871a7cc docs: add dft to docs 
Signed-off-by: Peter Gadfort <peter.gadfort@gmail.com>
 2025-01-13 12:25:28 -07:00
Song Luar
0aff237a5b [Docs] OR Review 2 (#4159) 
* update os matrix and reorder build instructions to put prebuilt>docker>local
* prototype for tabbed content for openroad APIs
* add sphinx_tabs
* Updated docs requirements.txt
* Now displays OpenROAD APIs nicely.

Signed-off-by: luarss <39641663+luarss@users.noreply.github.com>
Signed-off-by: Vitor Bandeira <vvbandeira@users.noreply.github.com>
Signed-off-by: Song Luar <espsluar@gmail.com>
Co-authored-by: Vitor Bandeira <vvbandeira@users.noreply.github.com>
 2024-08-27 10:36:18 -03:00
luarss
ca9ee67d01 update docs clarity 
Signed-off-by: luarss <39641663+luarss@users.noreply.github.com>
 2024-04-13 11:10:36 +08:00
luarss
0ea1fb99ae Add manpages to RTD 
Signed-off-by: luarss <39641663+luarss@users.noreply.github.com>
 2024-04-06 01:10:41 +08:00
luarss
ce247af710 Merge branch 'master' into manpage_poc 2024-02-06 15:03:30 +00:00
luarss
c8a072d261 add TclFormat, ReadmeFormat, ;#nodocs -> ;#checkeroff 
Signed-off-by: luarss <39641663+luarss@users.noreply.github.com>
 2024-02-03 03:23:11 +00:00
Song Luar
fcce4ab663 [Docs] gpl documentation (#3702) 
* gpl docs
* remove deprecated
* add defaults and datatypes
* update all except defaults
* add defaults
* update skip_io param

Signed-off-by: luarss <espsluar@gmail.com>
Signed-off-by: Vitor Bandeira <vvbandeira@users.noreply.github.com>
Co-authored-by: Vitor Bandeira <vvbandeira@users.noreply.github.com>
 2024-01-16 10:39:28 -03:00
Song Luar
ac2f785949 [Docs] Fix prebuilt instructions and comments (#3971) 
* edit comments
* add readme change

Signed-off-by: luarss <espsluar@gmail.com>
 2023-09-13 09:52:46 -03:00
Song Luar
3accaf6940 [Docs] TOC changes + Database Math (#3860) 
* doc changes + dbmath

Signed-off-by: luarss <espsluar@gmail.com>
Signed-off-by: Song Luar <39641663+luarss@users.noreply.github.com>
 2023-08-29 08:30:45 -03:00
Song Luar
0d4d71d2f6 [Docs] cts documentation (#3698) 
* cts docs update

---------

Signed-off-by: luarss <espsluar@gmail.com>
Signed-off-by: Vitor Bandeira <vvbandeira@users.noreply.github.com>
Co-authored-by: Vitor Bandeira <vvbandeira@users.noreply.github.com>
 2023-08-25 15:14:27 -03:00
Song Luar
80ac27ab69 [Docs] drt documentation (#3631) 
* update drt docs

---------

Signed-off-by: luarss <espsluar@gmail.com>
Signed-off-by: Vitor Bandeira <vvbandeira@users.noreply.github.com>
Co-authored-by: Vitor Bandeira <vvbandeira@users.noreply.github.com>
 2023-08-25 15:13:59 -03:00
Song Luar
11074f85ba [Docs] upf documentation (#3723) 
* upf documentation

---------

Signed-off-by: luarss <espsluar@gmail.com>
Signed-off-by: Vitor Bandeira <vvbandeira@users.noreply.github.com>
Co-authored-by: Vitor Bandeira <vvbandeira@users.noreply.github.com>
 2023-08-24 08:40:06 -03:00
Song Luar
c4905fbe71 [Docs] mpl2 documentation (#3617) 
* update mpl2 readme consistent with other tools

Signed-off-by: luarss <espsluar@gmail.com>
 2023-08-23 13:07:40 -03:00
Song Luar
a96c1173d0 [Docs] add link to ORFS (#3798) 
* add link to ORFS


Signed-off-by: luarss <espsluar@gmail.com>
 2023-08-10 15:16:58 -03:00
Song Luar
6fbc84f343 [Docs] Added OR messages glossary (#3506) 
* Added OR messages glossary

Signed-off-by: luarss <espsluar@gmail.com>
Co-authored-by: Vitor Bandeira <vvbandeira@precisioninno.com>
 2023-07-19 12:42:31 -03:00
Vitor Bandeira
7e6d6d7fa7 docs: add build to toc 
Signed-off-by: Vitor Bandeira <vvbandeira@precisioninno.com>
 2023-07-15 13:59:46 -03:00
Song Luar
708046a650 [Docs] Sphinx book theme change (#3522) 
* new docs theme

Signed-off-by: luarss <espsluar@gmail.com>
 2023-07-14 14:50:52 -03:00
Vitor Bandeira
b68a780090 docs: change to make links work 
Signed-off-by: Vitor Bandeira <vvbandeira@precisioninno.com>
 2023-06-08 15:11:32 -03:00
Vitor Bandeira
e1aab32a28 docs: add Build to toc 
Signed-off-by: Vitor Bandeira <vvbandeira@precisioninno.com>
 2023-06-08 15:11:32 -03:00
Vitor Bandeira
3ca6f82f2b docs: remove stale pdr references 
Signed-off-by: Vitor Bandeira <vvbandeira@precisioninno.com>
 2023-06-08 14:31:41 -03:00
Vitor Bandeira
271ea79bf7 docs: remove stale pdn references 
Signed-off-by: Vitor Bandeira <vvbandeira@precisioninno.com>
 2023-06-08 14:31:29 -03:00
Vitor Bandeira
4f897c55e6 docs: remove stale pad references 
Signed-off-by: Vitor Bandeira <vvbandeira@precisioninno.com>
 2023-06-08 14:30:59 -03:00
habibayassin
a0e24e93e6 Move ORFS docs to its own repo (#2603) 
* move orfs to its own repo

Signed-off-by: habibayassin <habibayassin@aucegypt.edu>
Signed-off-by: Vitor Bandeira <vvbandeira@users.noreply.github.com>
Co-authored-by: Vitor Bandeira <vvbandeira@users.noreply.github.com>
 2023-01-02 07:23:18 -03:00
Vitor Bandeira
69383bc9ff docs: add section for tools and cmds 
Signed-off-by: Vitor Bandeira <vitor.vbandeira@gmail.com>
 2022-12-24 09:41:34 -03:00
habibayassin
547a2605b1 rename tool categories in documentation (#2612) 
* rename categories

Signed-off-by: habibayassin <habibayassin@aucegypt.edu>
 2022-12-24 07:46:52 -03:00
Vitor Bandeira
4f99c0b2eb Add docs about CI. 
Signed-off-by: Vitor Bandeira <vitor.vbandeira@gmail.com>
 2022-03-31 19:31:26 -03:00
vijayank88
925a030aee ORFS Tutorial updated 2022-01-25 03:24:38 +00:00
vijayank88
4aee7b245a OR Flow variable 
Signed-off-by: vijayank88 <paruthi143@gmail.com>
 2021-12-28 16:59:27 +00:00
vijayank88
24b9e0e683 OpenROAD flow variables document 
Signed-off-by: vijayank88 <paruthi143@gmail.com>
 2021-12-28 10:19:19 +00:00
sewkim
27989f4e7b Update toc.yml 2021-12-25 03:40:33 -08:00
Vitor Bandeira
f98197c654 Docs ICeWall -> pad 
Signed-off-by: Vitor Bandeira <vitor.vbandeira@gmail.com>
 2021-11-30 14:29:32 -03:00
Vitor Bandeira
35494e74cf Fixup PlatformBringUp docs 
Signed-off-by: Vitor Bandeira <vitor.vbandeira@gmail.com>
 2021-11-30 14:27:47 -03:00
Ryan Ridley
db5480644f Added documentation for bringing up a new platform to work with OpenROAD-flow-scripts 
Signed-off-by: Ryan Ridley <ryan.ridley@okstate.edu>
 2021-11-13 13:19:25 -06:00
Matt Liberty
7c76af0826 add gui to docs and minor fixups 
Signed-off-by: Matt Liberty <mattliberty@gmail.com>
 2021-10-15 20:41:28 -07:00
osamahammad21
2fa1582da9 rename TritonRoute to drt 
Signed-off-by: osamahammad21 <osama21@aucegypt.edu>
 2021-08-22 14:33:39 +02:00
Vitor Bandeira
bf224ee8e8 Misc warns for rtd 
Signed-off-by: Vitor Bandeira <vitor.vbandeira@gmail.com>
 2021-08-19 12:20:45 -03:00
Vitor Bandeira
1f774b5714 Integration of ORFS documentation 
Signed-off-by: Vitor Bandeira <vitor.vbandeira@gmail.com>
 2021-08-18 15:17:19 -03:00
Vitor Bandeira
043d327b9c Refactor documentation 
Signed-off-by: Vitor Bandeira <vitor.vbandeira@gmail.com>
 2021-08-18 15:17:19 -03:00
Vitor Bandeira
cdb847312c Clean up: remove out-of-date files 
Signed-off-by: Vitor Bandeira <vitor.vbandeira@gmail.com>
 2021-08-18 15:17:19 -03:00
Vitor Bandeira
1f68fb77a4 rst -> md 
Signed-off-by: Vitor Bandeira <vitor.vbandeira@gmail.com>
 2021-08-18 15:17:19 -03:00