doc/socdoc: fix example
authorFlorent Kermarrec <florent@enjoy-digital.fr>
Thu, 20 Feb 2020 18:47:15 +0000 (19:47 +0100)
committerFlorent Kermarrec <florent@enjoy-digital.fr>
Thu, 20 Feb 2020 18:47:15 +0000 (19:47 +0100)
doc/socdoc.md

index 67a0c5a0c303660fcc0ea9e8ad9c51b52fb252fd..33329207c1f2369967812c42cc741e24c4d243d8 100644 (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