[libre-riscv-dev] Merging Repositories and Auto-Generating Static Documentation

Yehowshua yimmanuel3 at gatech.edu
Mon May 4 03:13:30 BST 2020

As Jacob mentioned earlier, I’m all in favor of merging nmutil, ieee754fpu <https://git.libre-soc.org/?p=ieee754fpu.git;a=summary>, and soc into one repository called soc.

Also, I’m working my way through the codebase and writing documentation. I strongly believe that the documentation should exist in the soc git repository itself so that anyone else who works with the docs only has to clone the git repository. This in fact seems fairly standard these days:

https://github.com/YosysHQ/nextpnr/tree/master/docs <https://github.com/YosysHQ/nextpnr/tree/master/docs>
https://github.com/SymbiFlow/prjtrellis/tree/master/docs <https://github.com/SymbiFlow/prjtrellis/tree/master/docs>
https://github.com/enjoy-digital/litex/tree/master/doc <https://github.com/enjoy-digital/litex/tree/master/doc>

If this is the case - it could be needlessly complex to try to pull these into the wiki directly. What we can do is have a static docs server at docs.libre-soc.org that builds upon every commit.

We can use python mkdocs or python sphinx or whatever.

This means that the wiki is not so much for documentation as it is for containing larger ideas about the Libre-SOC project itself.

Lastly, merging nmutil, ieee754fpu <https://git.libre-soc.org/?p=ieee754fpu.git;a=summary>, and soc into one repository called soc allows use to have one ./docs directory from which to build all documentation.

To merge these repositories is simple. Just copy ieee754fpu and nmutill into soc and modify the setup.py.

@Alain - how hard do you think it would be to setup a docs.libre-soc.org <http://docs.libre-soc.org/> subdomain?

Thoughts? Comments?


More information about the libre-riscv-dev mailing list