summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorTim 'mithro' Ansell <tansell@google.com>2021-04-13 10:06:44 -0700
committerTim 'mithro' Ansell <tansell@google.com>2021-04-13 12:21:08 -0700
commitd0fb39ddbdb5816c25870ca4db36985a70799a81 (patch)
tree67d03f746639cc3374b6e295d24ece0e9499d573 /docs/index.rst
parentb16d955f43dd8f59fc714d506461d1d9f8a4a777 (diff)
downloadfpga-interchange-schema-d0fb39ddbdb5816c25870ca4db36985a70799a81.tar.gz
fpga-interchange-schema-d0fb39ddbdb5816c25870ca4db36985a70799a81.tar.bz2
fpga-interchange-schema-d0fb39ddbdb5816c25870ca4db36985a70799a81.zip
Adding Sphinx documentation generation for the docs.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..d8dc21e
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,18 @@
+Welcome to FPGA Interchange documentation!
+==========================================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+ device_resources
+ bel_and_site_design
+ pseudo_cells
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`