Skip to content
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.

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

Add sphinx documentation and readthedocs generation #14

Open
mithro opened this issue Oct 12, 2022 · 2 comments
Open

Add sphinx documentation and readthedocs generation #14

mithro opened this issue Oct 12, 2022 · 2 comments

Comments

@mithro
Copy link
Contributor

mithro commented Oct 12, 2022

Sphinx (https://www.sphinx-doc.org/en/master/) is the used by a large number of the existing Python and open source EDA ecosystem (for example the Amaranth's own documentation uses Sphinx, the Google open source PDK's use it like SKY130 and GF180MCU, the F4PGA documentation -- even the Yosys documentation seems to be converting too) and it would be great to see this used here!

See also Teo's documentation @ https://github.com/tdene/synth_opt_adders/tree/main/docs -- There are also examples are http://cfu-playground.rtfd.io/, https://workshop.fomu.im/en/latest/

Other useful extensions for hardware are;

@mithro
Copy link
Contributor Author

mithro commented Oct 12, 2022

@umarcor probably has suggestions and thoughts as well!

@mithro
Copy link
Contributor Author

mithro commented Sep 5, 2023

@antonblanchard - Would you be interested in having this setup?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant