SymbiFlow / sphinx-verilog-domain

Sphinx domain to allow integration of Verilog / SystemVerilog documentation into Sphinx.
https://sphinx-verilog-domain.rtfd.io
Apache License 2.0
21 stars 7 forks source link

Check the sphinx-verilog-domain works well with symbolator #2

Closed mithro closed 4 years ago

mithro commented 4 years ago

https://github.com/SymbiFlow/symbolator

mglb commented 4 years ago

It does work, example use case: https://antmicro.github.io/sphinx-verilog-domain/symbolator.html

Is this enough, or should I check for some additional use cases?

mithro commented 4 years ago

@mglb - Is that included in the repo?

mglb commented 4 years ago

It is: https://github.com/SymbiFlow/sphinx-verilog-domain/blob/master/example/source/symbolator.rst

However, it is included conditionally (only when Symbolator is installed): https://github.com/SymbiFlow/sphinx-verilog-domain/blob/master/example/source/conf.py#L30

GitHub
SymbiFlow/sphinx-verilog-domain
Contribute to SymbiFlow/sphinx-verilog-domain development by creating an account on GitHub.
GitHub
SymbiFlow/sphinx-verilog-domain
Contribute to SymbiFlow/sphinx-verilog-domain development by creating an account on GitHub.
rw1nkler commented 4 years ago

The test is added to the RTD output: https://sphinx-verilog-domain.readthedocs.io/en/latest/tests/symbolator.html

Symbolator compatibility test — Sphinx Verilog Domain 0.1 documentation