Hardware
/
litex
mirror of https://github.com/enjoy-digital/litex.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc/socdoc: fix example

This commit is contained in:
Florent Kermarrec 2020-02-20 19:47:15 +01:00
parent 53ee9a5e05
commit 485934edc9
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/socdoc.md
View File

@ -19,15 +19,15 @@ To document your modules, import the `doc` module and call `doc.generate_docs(so
You can also generate an SVD file. For example:
```python
import litex.soc.doc
from litex.soc.doc import generate_docs, generate_svd
...
soc = BaseSoC(platform)
builder = Builder(soc)
vns = builder.build()
soc.do_exit(vns)
doc.generate_docs(soc, "build/documentation")
doc.generate_svd(soc, "build/software")
generate_docs(soc, "build/documentation")
generate_svd(soc, "build/software")
```
After you build your design, you will have a Sphinx documentation source available