3
0
Fork 0
mirror of https://github.com/YosysHQ/sby.git synced 2025-04-05 22:14:08 +00:00
sby/docs/source/index.rst
Krystine Sherwin 27e20fd5c3
Add sphinx-argparse to generate usage
Move parser generation into a seperate file to avoid import issues with bad python modules during docs gen.
With the requirements.txt provided to readthedocs, there shouldn't need to be any other changes?
Also I've never been able to run `make test` so I'm not actually sure if the changes break sby, but they shouldn't.
2023-06-13 11:40:28 +12:00

26 lines
582 B
ReStructuredText

SymbiYosys (sby) Documentation
==============================
SymbiYosys (sby) is a front-end driver program for Yosys-based formal
hardware verification flows. SymbiYosys provides flows for the following
formal tasks:
* Bounded verification of safety properties (assertions)
* Unbounded verification of safety properties
* Generation of test benches from cover statements
* Verification of liveness properties
.. toctree::
:maxdepth: 3
install.rst
quickstart.rst
usage.rst
reference.rst
autotune.rst
verilog.rst
verific.rst
license.rst