OpenFPGA/docs/source/index.rst

64 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::
:caption: Motivation
motivation
.. toctree::
:caption: Getting Started
eda_flow
2018-09-13 16:38:41 -05:00
.. toctree::
:maxdepth: 2
2018-10-18 17:28:12 -05:00
:caption: Tools Guide
2018-09-13 16:38:41 -05:00
2018-09-13 18:39:57 -05:00
arch_lang/index
2018-09-13 16:38:41 -05:00
2018-09-13 18:39:57 -05:00
fpga_spice/index
fpga_verilog/index
fpga_bitstream/index
2018-09-13 16:38:41 -05:00
.. toctree::
:maxdepth: 2
2018-10-18 17:28:12 -05:00
:caption: User Guide
2018-09-13 18:39:57 -05:00
tutorials/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
contact
2018-09-13 18:39:57 -05:00
reference
2018-09-13 16:38:41 -05:00
2018-12-10 14:46:38 -06:00
For more information on the VTR see vtr_doc_ // vtr_github_
2018-09-13 16:38:41 -05:00
2018-12-10 14:46:38 -06:00
For more information on the Yosys see yosys_doc_ // yosys_github_
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`
.. _yosys_doc: http://www.clifford.at/yosys/
.. _yosys_github: https://github.com/YosysHQ/yosys
.. _vpr_doc: https://docs.verilogtorouting.org/en/latest/
.. _vpr_github: https://github.com/verilog-to-routing/vtr-verilog-to-routing
.. _xml_vtr: https://docs.verilogtorouting.org/en/latest/arch/reference/