SymbiFlow / awesome-rtl-docs-template

Template repository which shows how to set up awesome documentation for your Verilog / SystemVerilog / Migen / nMigen project using Sphinx and extensions
3 stars 0 forks source link

Add repo contents #1

Open mithro opened 3 years ago

mithro commented 3 years ago

This repository should show how to create awesome documentation for your RTL project using Sphinx.

It should include;

Some examples are;

It should also include how to use the SymbiFlow conda packages to get sphinxcontrib-hdl-diagrams working with readthedocs.

mithro commented 3 years ago

@mgielda / @rw1nkler / @kgugala - We now have a lot of awesome sphinx extensions which make it great to use sphinx to document your RTL code. We should set up this repository as a template that people can use to quickly get started. See https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template

Creating a repository from a template - GitHub Docs
You can generate a new repository with the same directory structure and files as an existing repository.