mirrors/yosys
3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-06-06 06:03:23 +00:00
Code Activity

Docs: Cell reference as a custom documenter

Browse source 
Use autodocs to perform cell reference docs generation instead of generating rst files directly.
e.g.
```
.. autocell:: simlib.v:$alu
   :source:
   :linenos:
```
This commit is contained in:
Krystine Sherwin 2024-05-17 17:54:08 +12:00
parent 06e5e18371
commit e5f54dd7cd
No known key found for this signature in database
3 changed files with 526 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/source/conf.py
View file

@ -100,9 +100,14 @@ latex_elements = {
sys.path += [os.path.dirname(__file__) + "/../"]
extensions.append('util.cmdref')
def setup(sphinx):
from util.RtlilLexer import RtlilLexer
sphinx.add_lexer("RTLIL", RtlilLexer)
# use autodocs
extensions.append('sphinx.ext.autodoc')
extensions.append('util.cellref')
from util.YoscryptLexer import YoscryptLexer
sphinx.add_lexer("yoscrypt", YoscryptLexer)
from sphinx.application import Sphinx
def setup(app: Sphinx) -> None:
from util.RtlilLexer import RtlilLexer
app.add_lexer("RTLIL", RtlilLexer)
from util.YoscryptLexer import YoscryptLexer
app.add_lexer("yoscrypt", YoscryptLexer)