-
Notifications
You must be signed in to change notification settings - Fork 893
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
Add docs generation from cells help output #4332
Commits on Oct 14, 2024
-
Configuration menu - View commit details
-
Copy full SHA for a6641da - Browse repository at this point
Copy the full SHA a6641daView commit details -
Docs: Put cell library help strings into a struct
Allows for more expressive code when constructing help messages for cells. Will also move extra logic in parsing help strings into the initial python parse instead of doing it in the C++ at export time.
Configuration menu - View commit details
-
Copy full SHA for 6bbe763 - Browse repository at this point
Copy the full SHA 6bbe763View commit details -
Configuration menu - View commit details
-
Copy full SHA for 600149a - Browse repository at this point
Copy the full SHA 600149aView commit details -
Configuration menu - View commit details
-
Copy full SHA for 4662476 - Browse repository at this point
Copy the full SHA 4662476View commit details -
Configuration menu - View commit details
-
Copy full SHA for 1e5a50f - Browse repository at this point
Copy the full SHA 1e5a50fView commit details -
Configuration menu - View commit details
-
Copy full SHA for 7842926 - Browse repository at this point
Copy the full SHA 7842926View commit details -
cellhelp: Add source line to help
Include Source file and line number in SimHelper struct, and use it for verilog code caption in rst dump. Also reformat python string conversion to iterate over a list of fields instead of repeating code for each.
Configuration menu - View commit details
-
Copy full SHA for a2b2904 - Browse repository at this point
Copy the full SHA a2b2904View commit details -
cellhelp: Add default format parse for simcells
Since `simcells.v` uses consistent formatting we can handle it specifically to help tidy up sphinx warnings about the truth tables, and instead chuck them in a code block which when printing to rst. Also has the side effect that rst code blocks can be added manually with `//- ::` followed by a blank line.
Configuration menu - View commit details
-
Copy full SHA for 57cd8d2 - Browse repository at this point
Copy the full SHA 57cd8d2View commit details -
Docs: Add cell gen to makefile
Generate in a temp directory and use `rsync -rc` to only update rst files that have changed. This prevents sphinx from having to re-generate every cmd/cell page any time the git sha changes. Also change cmd gen to match.
Configuration menu - View commit details
-
Copy full SHA for 1a4ada4 - Browse repository at this point
Copy the full SHA 1a4ada4View commit details -
Configuration menu - View commit details
-
Copy full SHA for d629aa6 - Browse repository at this point
Copy the full SHA d629aa6View commit details -
Configuration menu - View commit details
-
Copy full SHA for c98d134 - Browse repository at this point
Copy the full SHA c98d134View commit details -
Subclass the command reference code in order to support smart references to the internal cells.
Configuration menu - View commit details
-
Copy full SHA for f9b4e04 - Browse repository at this point
Copy the full SHA f9b4e04View commit details -
Use new `autoref` role when using single backticks. Allows automatic mapping to a cmd ref or a cell ref.
Configuration menu - View commit details
-
Copy full SHA for c0f9828 - Browse repository at this point
Copy the full SHA c0f9828View commit details -
Configuration menu - View commit details
-
Copy full SHA for e4ec371 - Browse repository at this point
Copy the full SHA e4ec371View commit details -
Configuration menu - View commit details
-
Copy full SHA for 829e02e - Browse repository at this point
Copy the full SHA 829e02eView commit details -
Configuration menu - View commit details
-
Copy full SHA for 40ba92e - Browse repository at this point
Copy the full SHA 40ba92eView commit details -
- Drop `cell_code` and instead map code lookups to the `cell_help` dict. - Add helper functions to struct for checking and getting the right cell. - Add `CellType` for cell to `write_cell_rst` function declaration in preparation for use in future. - Iterate over `yosys_celltypes.cell_types` when exporting cell rst files, reporting errors for any cells defined in `cell_types` but not `cell_help_messages`.
Configuration menu - View commit details
-
Copy full SHA for 21747c4 - Browse repository at this point
Copy the full SHA 21747c4View commit details -
Configuration menu - View commit details
-
Copy full SHA for 4c9c4c1 - Browse repository at this point
Copy the full SHA 4c9c4c1View commit details -
Configuration menu - View commit details
-
Copy full SHA for 063a6bc - Browse repository at this point
Copy the full SHA 063a6bcView commit details -
Configuration menu - View commit details
-
Copy full SHA for 06e5e18 - Browse repository at this point
Copy the full SHA 06e5e18View commit details -
Docs: Cell reference as a custom documenter
Use autodocs to perform cell reference docs generation instead of generating rst files directly. e.g. ``` .. autocell:: simlib.v:$alu :source: :linenos: ```
Configuration menu - View commit details
-
Copy full SHA for e5f54dd - Browse repository at this point
Copy the full SHA e5f54ddView commit details -
Configuration menu - View commit details
-
Copy full SHA for a66e94c - Browse repository at this point
Copy the full SHA a66e94cView commit details -
Configuration menu - View commit details
-
Copy full SHA for 1b0d863 - Browse repository at this point
Copy the full SHA 1b0d863View commit details -
Configuration menu - View commit details
-
Copy full SHA for ccd3bac - Browse repository at this point
Copy the full SHA ccd3bacView commit details -
Fix RTD not including source with warning `WARNING: invalid signature for autocellsource ('/home/docs/checkouts/readthedocs.org/user_builds/yosys/checkouts/manual-rewrite/source/generated/simlib.v:$alu::__source')`.
Configuration menu - View commit details
-
Copy full SHA for 84f2968 - Browse repository at this point
Copy the full SHA 84f2968View commit details -
Configuration menu - View commit details
-
Copy full SHA for 7eb33f1 - Browse repository at this point
Copy the full SHA 7eb33f1View commit details -
New `help -dump-cells-json <file>` to dump cells list. Add 'group' field to SimHelper class/struct with defaults to gate_other and word_other depending on source (simcells or simlib). Add 'unary' group to unary operator cells for testing (based on internal cell library docs page).
Configuration menu - View commit details
-
Copy full SHA for 7c5b10f - Browse repository at this point
Copy the full SHA 7c5b10fView commit details -
Docs: Move appendix toc to main toc
Adds an Appendix header to sidebar toc instead of being an (empty) subpage.
Configuration menu - View commit details
-
Copy full SHA for a119d41 - Browse repository at this point
Copy the full SHA a119d41View commit details -
Configuration menu - View commit details
-
Copy full SHA for 9533cf2 - Browse repository at this point
Copy the full SHA 9533cf2View commit details -
e.g. ``` .. autocell:: $alu :source: :linenos: ```
Configuration menu - View commit details
-
Copy full SHA for 37573a6 - Browse repository at this point
Copy the full SHA 37573a6View commit details -
Configuration menu - View commit details
-
Copy full SHA for 6572320 - Browse repository at this point
Copy the full SHA 6572320View commit details -
Configuration menu - View commit details
-
Copy full SHA for 5a4a419 - Browse repository at this point
Copy the full SHA 5a4a419View commit details -
Docs: Preliminary autocellgroup usage
Remove `/source/cell` from .gitignore. Add a few initial cell pages. Add YosysCellGroup documenter and cell:group directive. Update Documenters to use nested json. Better nested tocs for group.module.source layout.
Configuration menu - View commit details
-
Copy full SHA for b127ac0 - Browse repository at this point
Copy the full SHA b127ac0View commit details -
Docs: Move binary operators to cell appendix
Add binary group tag to relevant cells. Remove content from `cell_library.rst` that is already moved.
Configuration menu - View commit details
-
Copy full SHA for c662529 - Browse repository at this point
Copy the full SHA c662529View commit details -
cellref: Move default help message to register.cc
Drop the default help message from rst while still displaying it on the command line. Fix command line formatting for older style help messages.
Configuration menu - View commit details
-
Copy full SHA for 04b0ae5 - Browse repository at this point
Copy the full SHA 04b0ae5View commit details -
cellref: Deprecate cell_library.rst
Most of the word/coarse level cells have an assigned group and individual page. The gate/fine level cells are all on one page. Fix links to `cell_library.rst`.
Configuration menu - View commit details
-
Copy full SHA for 1374fc2 - Browse repository at this point
Copy the full SHA 1374fc2View commit details -
Configuration menu - View commit details
-
Copy full SHA for 46580ce - Browse repository at this point
Copy the full SHA 46580ceView commit details -
Configuration menu - View commit details
-
Copy full SHA for 2b4a4cb - Browse repository at this point
Copy the full SHA 2b4a4cbView commit details -
Configuration menu - View commit details
-
Copy full SHA for be5572c - Browse repository at this point
Copy the full SHA be5572cView commit details -
Configuration menu - View commit details
-
Copy full SHA for 6aceb6a - Browse repository at this point
Copy the full SHA 6aceb6aView commit details -
Configuration menu - View commit details
-
Copy full SHA for e78841b - Browse repository at this point
Copy the full SHA e78841bView commit details -
Configuration menu - View commit details
-
Copy full SHA for 11d2cbc - Browse repository at this point
Copy the full SHA 11d2cbcView commit details -
Configuration menu - View commit details
-
Copy full SHA for c6414e0 - Browse repository at this point
Copy the full SHA c6414e0View commit details -
Docs: Assign remaining word cells to groups
Move todos to correct place. Add todo for x-prop cells.
Configuration menu - View commit details
-
Copy full SHA for 78b9dbd - Browse repository at this point
Copy the full SHA 78b9dbdView commit details -
Configuration menu - View commit details
-
Copy full SHA for 596d914 - Browse repository at this point
Copy the full SHA 596d914View commit details -
Configuration menu - View commit details
-
Copy full SHA for b0bc29e - Browse repository at this point
Copy the full SHA b0bc29eView commit details -
Configuration menu - View commit details
-
Copy full SHA for 5473b60 - Browse repository at this point
Copy the full SHA 5473b60View commit details -
Drop word_other block since it raises a warning, which will cause the RTDs build to fail.
Configuration menu - View commit details
-
Copy full SHA for 0005083 - Browse repository at this point
Copy the full SHA 0005083View commit details -
Configuration menu - View commit details
-
Copy full SHA for 217c2a1 - Browse repository at this point
Copy the full SHA 217c2a1View commit details -
Configuration menu - View commit details
-
Copy full SHA for 5c4f7b4 - Browse repository at this point
Copy the full SHA 5c4f7b4View commit details -
Explicitly assign $_TBUF_ to `gate_other` and remove catch if a cell has no group.
Configuration menu - View commit details
-
Copy full SHA for f70a66f - Browse repository at this point
Copy the full SHA f70a66fView commit details -
Configuration menu - View commit details
-
Copy full SHA for 9ce6952 - Browse repository at this point
Copy the full SHA 9ce6952View commit details -
cellhelp.py: Cells can have tags
Tags are added to the list of properties when exporting to `cells.json`.
Configuration menu - View commit details
-
Copy full SHA for b1025db - Browse repository at this point
Copy the full SHA b1025dbView commit details -
simlib.v: Update case equality operators to v2
Also tag as x-aware cells and add titles.
Configuration menu - View commit details
-
Copy full SHA for ed92374 - Browse repository at this point
Copy the full SHA ed92374View commit details -
Configuration menu - View commit details
-
Copy full SHA for 1a24018 - Browse repository at this point
Copy the full SHA 1a24018View commit details -
Docs: Drop fifo.out and fifo.stat
These two files can now be safely .gitignore'd.
Configuration menu - View commit details
-
Copy full SHA for e3d939b - Browse repository at this point
Copy the full SHA e3d939bView commit details -
docs/util: Cells now have properties
Properties are both an option: ``` .. cell:def:: $add :properties: is_evaluable ``` and a field: ``` .. cell:def:: $eqx :property x-aware: :property is_evaluable: ``` Properties as an option appear in the property index: linking a given property to all cells with that property; while properties as a field display with the cell.
Configuration menu - View commit details
-
Copy full SHA for ce6a7fe - Browse repository at this point
Copy the full SHA ce6a7feView commit details -
Configuration menu - View commit details
-
Copy full SHA for 4d84d7e - Browse repository at this point
Copy the full SHA 4d84d7eView commit details -
Add properties page, move cell_gate and cell_word under a singular cell_index along with properties. Fix links accordingly. Also drop x-aware and x-output todos since they are resolved.
Configuration menu - View commit details
-
Copy full SHA for e40134c - Browse repository at this point
Copy the full SHA e40134cView commit details -
Configuration menu - View commit details
-
Copy full SHA for 9d808ca - Browse repository at this point
Copy the full SHA 9d808caView commit details -
Configuration menu - View commit details
-
Copy full SHA for 7216f07 - Browse repository at this point
Copy the full SHA 7216f07View commit details -
Also put property lists *after* cell description.
Configuration menu - View commit details
-
Copy full SHA for 927dc44 - Browse repository at this point
Copy the full SHA 927dc44View commit details -
- Unswap shift/shiftx - Add brief overview to cell lib - Clarify $div cell B input - Clarify unary operators - What is $modfloor
Configuration menu - View commit details
-
Copy full SHA for dfe803b - Browse repository at this point
Copy the full SHA dfe803bView commit details -
Docs: Adding mux cell descriptions
Also making ver2 cell descriptions consistently spaced.
Configuration menu - View commit details
-
Copy full SHA for 1513366 - Browse repository at this point
Copy the full SHA 1513366View commit details -
$lut and $sop were missed in the rebase, and $buf is new to main since the last rebase.
Configuration menu - View commit details
-
Copy full SHA for 27b8b4e - Browse repository at this point
Copy the full SHA 27b8b4eView commit details -
Configuration menu - View commit details
-
Copy full SHA for c93fd54 - Browse repository at this point
Copy the full SHA c93fd54View commit details -
Configuration menu - View commit details
-
Copy full SHA for bc77575 - Browse repository at this point
Copy the full SHA bc77575View commit details
Commits on Oct 16, 2024
-
Configuration menu - View commit details
-
Copy full SHA for e9d9e92 - Browse repository at this point
Copy the full SHA e9d9e92View commit details