OpenFPGA/docs/source/index.rst

59 lines
1.3 KiB
ReStructuredText
Raw Normal View History

2018-09-13 16:38:41 -05:00
.. OpenFPGA documentation master file, created by
sphinx-quickstart on Thu Sep 13 12:15:14 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to OpenFPGA's documentation!
====================================
2018-09-13 23:58:54 -05:00
.. toctree::
:maxdepth: 2
:caption: Overview
2018-09-13 23:58:54 -05:00
overview/index
2018-09-13 23:58:54 -05:00
.. toctree::
:maxdepth: 2
:caption: Tutorials
2018-09-13 23:58:54 -05:00
tutorials/index
2019-09-01 23:15:53 -05:00
2018-09-13 16:38:41 -05:00
.. toctree::
:maxdepth: 2
:caption: User Manual
2018-09-13 16:38:41 -05:00
manual/index
2018-09-13 16:38:41 -05:00
2021-01-26 17:26:43 -06:00
.. toctree::
:maxdepth: 2
:caption: Developers Manual
dev_manual/index
2018-09-13 16:38:41 -05:00
.. toctree::
2018-09-13 18:39:57 -05:00
:maxdepth: 2
2018-09-13 16:38:41 -05:00
:caption: Appendix
2019-09-01 23:15:53 -05:00
2018-09-13 16:38:41 -05:00
contact
2018-09-13 18:39:57 -05:00
reference
2021-07-28 11:14:31 -05:00
faq
2019-09-01 23:15:53 -05:00
For more information on the VTR see vtr_doc_ or vtr_github_
2018-09-13 16:38:41 -05:00
For more information on the Yosys see yosys_doc_ or yosys_github_
2018-12-10 14:46:38 -06:00
For more information on the original FPGA architecture description language see xml_vtr_
2018-09-13 16:38:41 -05:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
2019-01-03 11:26:30 -06:00
.. _vtr_doc: https://docs.verilogtorouting.org/en/latest/
.. _vtr_github: https://github.com/verilog-to-routing/vtr-verilog-to-routing
2019-01-03 11:18:03 -06:00
.. _yosys_doc: http://www.clifford.at/yosys/
.. _yosys_github: https://github.com/YosysHQ/yosys
.. _xml_vtr: https://docs.verilogtorouting.org/en/latest/arch/reference/