README.md

lxsocdoc: Document your LiteX SoC Automatically

lxsocdoc lets you take a synthesized LiteX SoC and generate full register-level documentation. Additionally, it will generate .svd files, suitable for use with various header generation programs.

Required Software

You must have sphinx and sphinx.wavedrom installed in order to build the documentation. These can be installed with pip:

$ pip3 install sphinxcontrib-wavedrom sphinx

Usage

To use lxsocdoc, import the module and call lxsocdoc.generate_docs(soc, path). You can also generate an SVD file. For example:

import lxsocdoc

...
    soc = BaseSoC(platform)
    builder = Builder(soc)
    vns = builder.build()
    soc.do_exit(vns)
    lxsocdoc.generate_docs(soc, "build/documentation")
    lxsocdoc.generate_svd(soc, "build/software")

After you build your design, you will have a Sphinx documentation source available in the above directory. To build this into a target document, use sphinx-build.

For example, if sphinx-build is in your path, you can run:

sphinx-build -M html build/documentation/ build/documentation/_build

sphinx-build may be located in ~/.local/bin/ depending on your installation environment.

You can then verify the contents by starting a local webserver and opening a web browser to localhost:8000:

python3 -m http.server --directory build/documentation/_build/html