New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add repo contents #1

Open

mithro opened this issue Sep 18, 2020 · 1 comment

Assignees

Member

mithro commented Sep 18, 2020

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

It should include;

Some examples are;

SymbiFlow documentation - https://SymbiFlow.rtfd.io
SkyWater-pdk documentation - https://SkyWater-pdk.rtfd.io
Fomu workshop - https://workshop.fomu.im

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

mithro assigned mgielda and rw1nkler

Member Author

mithro commented Sep 18, 2020 •

edited by unfurl-links bot

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment