doc: add Sphinx site and publish it through GitHub Pages #138
Conversation
| </p> | ||
|
|
||
| Universal utility for programming FPGAs. Compatible with many boards, cables and FPGA from major manufacturers (Xilinx, Altera/Intel, Lattice, Gowin, Efinix, Anlogic). openFPGALoader works on [Linux](INSTALL.md#linux), [Windows](INSTALL.md#windows) and [macOS](INSTALL.md#macos). | ||
| Universal utility for programming FPGAs. Compatible with many boards, cables and FPGA from major manufacturers (Xilinx, Altera/Intel, Lattice, Gowin, Efinix, Anlogic). openFPGALoader works on Linux, Windows and macOS. |
There was a problem hiding this comment.
Maybe not really important, but why not keeping links?
There was a problem hiding this comment.
I found it redundant given there is a visible sidebar in trabucayre.github.io/openFPGALoader/guide/install:
Nevertheless, I can bring them back if you want.
|
Awesome! |
|
Applied |
|
@trabucayre note that you can edit the fields in the sidebar of the root of the repo, in order to show the URL there:
See, for instance, https://github.com/edaa-org/pyEDAA.ProjectModel. |
|
Sidebard updated ! Thanks |
As proposed in #102 (comment), this PR converts documentation sources from markdown to restructuredtext, and the configuration files for an Sphinx site are added. A job in the CI workflow builds the site and pushes it to branch
gh-pages, so that it is served at trabucayre.github.io/openFPGALoader. That works for forks as well. See, for instance, umarcor.github.io/openFPGALoader.The main reason for using Sphinx, apart from interpshinx, is being able to enhance the documentation with timing diagrams through wavedrom. See https://wishbone-interconnect.readthedocs.io/en/latest/03_classic.html#reset-operation.