Commit graph

9 commits

Author SHA1 Message Date
Mike Thompson
8a561eddcf
HotFix: need the latest version of Sphinx 2024-01-30 10:26:13 -05:00
Christian Herber
5c5aaae1f0 Adding Jinja2 with version restriction to requirements
- Jinja2 is required by sphinx
- Version 3.1 and later are incompatible with the specified sphinx version
- see https://github.com/sphinx-doc/sphinx/issues/10291
- explicitly requiring this older version of Jinja2 solves this
- could be removed when moving to newer sphinx version
2023-07-05 17:15:38 +02:00
Philipp Wagner
252dde8225 [doc] Require Sphinx 3 until wavedrom is compatible
Sphinx 4 removed some deprecated functionality that was still used by
sphinxcontrib-wavedrom. Use Sphinx 3 until wavedrom releases an updated
version.
2021-05-11 18:28:56 +01:00
Philipp Wagner
6d81447d67 Doc: Switch back to upstream Sphinx
Upstream has now released a new version which includes Stefan's patch to
correctly build the PDFs.

Fixes #41
2019-06-05 12:56:58 +01:00
Stefan Wallentowitz
62185d054e Temporarily switch to custom sphinx
Using figures in admonitions did not work so far. A patch was created
and merge is pending. As long as it is not merged, use custom sphinx.

Fixes #24
2019-05-16 13:27:32 +01:00
Stefan Wallentowitz
5d419cbf16 Fix wavedrom versions
Ensure to pickup the correct versions for wavedrom.
2019-05-15 10:34:41 +01:00
Stefan Wallentowitz
dc27666c92
Doc: Bump sphinx version 2018-11-23 20:34:47 +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