From: Florent Kermarrec Date: Thu, 20 Feb 2020 18:47:15 +0000 (+0100) Subject: doc/socdoc: fix example X-Git-Tag: 24jan2021_ls180~646 X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=485934edc9c1e123e3e39911b910b51aa3196b19;p=litex.git doc/socdoc: fix example --- diff --git a/doc/socdoc.md b/doc/socdoc.md index 67a0c5a0..33329207 100644 --- a/doc/socdoc.md +++ b/doc/socdoc.md @@ -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