f4pga / ideas

Random ideas and interesting ideas for things we hope to eventually do.
86 stars 9 forks source link

Convert yosys documentation to be sphinx compatible #8

Open mithro opened 6 years ago

mithro commented 6 years ago

Yosys currently has a lot of documentation however it is in Latex format.

It would be much better if it was in sphinx compatible format that could be published on readthedocs.

nobodywasishere commented 3 years ago

I've started working on this. I wrote a small script to convert all the latex documentation into rst, then used sphinx to build it. It is still very rough (and produces a lot of errors when compiling) and some of the formatting didn't transfer correctly, but it works and it's a start. I'm unsure whether the rst docs should necessarily be split from the latex version (to fix errors and such) or whether that should be done automatically (by adding to the sphinx.sh script) to keep one source of the documentation. I used sphinx_symbiflow_theme.

Code: https://github.com/nobodywasishere/yosys/tree/sphinx-docs Site: https://blog.eowyn.net/yosys/

GitHub
nobodywasishere/yosys
Yosys Open SYnthesis Suite. Contribute to nobodywasishere/yosys development by creating an account on GitHub.
Abstract — Yosys documentation