sphinx - Needed for production of html, pdf and other format documentations. * Instructions for build, install and interface with projects. * TODO - nmutil, ieee754fpu, dev-env-setup build scripts DONE * TODO - Add to Makefile to produce html docs. DONE * TODO - Add the generated html docs to website.
veera these were quick notes. i have added sphinx to the soc Makefile, the same thing needs to be added to nmutil and ieee754fpu. you also have to copy over conf.py from soc and edit it accordingly ("Documentation for nmutil" not "documentation for SOC"). then if you look at http://libre-soc.org/docs you will see there are hyperlinks to docs.libre-soc.org locations. the upload locations in the Makefiles need to match. plus, you will see an "intersphinx" in the soc conf.py, nmutil and ieee754fpu need to be added to it.
Added and setup the sphinx for nmutil. 1) Added conf.py and index.rst 2) Setup Makefile for sphinx Please review nmutil + sphinx.
Sphinx script for dev-env-script? For nmutil, I used only: apt-get install python3-sphinx python3-sphinx-rtd-theme python3-recommonmark Do you wanna me add these to a install script in dev-env-script.git? I will wait till ieee754fpu setup.
(In reply to vklr@vkten.in from comment #3) > Sphinx script for dev-env-script? > > For nmutil, I used only: > > apt-get install python3-sphinx python3-sphinx-rtd-theme python3-recommonmark that is probably enough > Do you wanna me add these to a install script in dev-env-script.git? the main dependencies one yes please, they are global in nature to the install-hdl-reqs one > I will wait till ieee754fpu setup.
Added and setup the sphinx for ieee754fpu. 1) Added conf.py and index.rst 2) Setup Makefile for sphinx Please review ieee754fpu + sphinx.
Added sphinx dependencies to dev-env-setup/install-hdl-apt-reqs. uri: https://git.libre-soc.org/?p=dev-env-setup.git;a=blob;f=install-hdl-apt-reqs;h=9ef6dd5ef727eb79dadd38bbfdf0519c8eaba04c;hb=HEAD Please review.
In both nmutil and ieee754fpu, the intersphinx path for nmigen is now fixed (probably: please check) in conf.py. This may have to be done in soc.git/conf.py also. Please review.
https://docs.libre-soc.org/nmutil/src/gen/nmutil.html#module-nmutil.stageapi looks really good.
https://git.libre-soc.org/?p=dev-env-setup.git;a=commitdiff;h=768f619de5ef6811460c837d6e2fb9a4d380af77 excellent. https://git.libre-soc.org/?p=libreriscv.git;a=blob;f=docs.mdwn;h=20d0b3e0ecf559b62fac3a00121df735f581be1f;hb=54085f30f2afd887d2780e57b61d885c177782ba#l15 needs the links adding * https://docs.libre-soc.org/nmigen/ * https://docs.libre-soc.org/ieee754fpu/ then i think we're done with this one. good stuff.
(In reply to Luke Kenneth Casson Leighton from comment #9) > > needs the links adding > * https://docs.libre-soc.org/nmigen/ > * https://docs.libre-soc.org/ieee754fpu/ > > then i think we're done with this one. good stuff. Links added.