Commit graph

7 commits

Author SHA1 Message Date
Philipp Wagner
b1af9174dc Doc: Documented supported tool versions
Add a section on supported tools to the Ibex documentation. Populate it
with my knowledge about tools we've tried. That's a starting point: we
need to add more version numbers and other information as we collect
more data points.

The Verilator version is taken from the new tool_requirements.py file
and inserted into Sphinx.
2020-02-12 15:57:40 +00:00
Philipp Wagner
db62f5b0c2 Doc: Cleanup Sphinx config file
- Add a license header
- Explicitly specify language
- Remove unused HTML help section
- Reorganize some commands around the version number generation
2020-02-12 15:57:40 +00:00
Greg Chadwick
29d66a7fa4 [Doc] Fix for table wrapping in RTD theme
This causes wide tables to wrap content within their cells rather than
producing a table with a scroll bar see
https://github.com/readthedocs/sphinx_rtd_theme/issues/117 for details.
2019-10-04 11:36:24 +01:00
Pirmin Vogel
b32078138c Doc: Adjust upper left corner: background color, logo etc. 2019-06-07 13:49:12 +01:00
Philipp Wagner
1b82b1bb7c Adjust documentation for ibex
With the rename from zero-riscy to ibex, and subsequent cleanups, the
documentation needs an update too.
2019-04-26 15:09:00 +01:00
Stefan Wallentowitz
99964c84d2 Doc: Inline documentation of waveforms
So far I used wavedrom for rendering, but that required external
tooling. After patching the extension, sphinx can now render inline
waveforms!
2018-11-21 16:09:02 +01:00
Stefan Wallentowitz
c6eeb34f57 Convert documentation to restructured text
Convert the documentation to restructured text. It looks slightly
different to the previous Word document, but can better be handled by
source control. It also automatically handles the versioning.

To build it:

    python -m venv venv
    source venv/bin/activate
    pip install -r requirements.txt
    make html
    make latexpdf
2018-11-13 16:21:47 +01:00