diff --git a/.gitmodules b/.gitmodules index 2cbe0fa..1b8cf5c 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,20 +1,3 @@ -[submodule "source/prjtrellis"] - path = source/prjtrellis - url = https://github.com/SymbiFlow/prjtrellis - branch = master -[submodule "source/symbiflow-arch-defs"] - path = source/symbiflow-arch-defs - url = https://github.com/SymbiFlow/symbiflow-arch-defs - branch = master -[submodule "source/prjxray"] - path = source/prjxray - url = https://github.com/SymbiFlow/prjxray -[submodule "source/fasm"] - path = source/fasm - url = https://github.com/SymbiFlow/fasm -[submodule "source/vtr-verilog-to-routing"] - path = source/vtr-verilog-to-routing - url = https://github.com/SymbiFlow/vtr-verilog-to-routing [submodule "third_party/make-env"] path = third_party/make-env url = https://github.com/SymbiFlow/make-env/ diff --git a/source/conf.py b/source/conf.py index 79cab71..4d06500 100644 --- a/source/conf.py +++ b/source/conf.py @@ -26,6 +26,7 @@ sys.path.append(os.path.abspath('./vtr-verilog-to-routing/doc/_exts')) # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ + 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.autodoc', 'sphinx.ext.imgmath', # breathe @@ -350,3 +351,14 @@ def prjxray_fuzzers_and_minitests_links(): subprocess.call(cmd, shell=True) prjxray_fuzzers_and_minitests_links() + +# -- Sphinx.Ext.InterSphinx -------------------------------------------------------------------------------------------- + +intersphinx_mapping = { + "python": ("https://docs.python.org/3/", None), + "arch-defs": ("https://symbiflow.readthedocs.io/projects/arch-defs/en/latest/", None), + "fasm": ("https://fasm.readthedocs.io/en/latest/", None), + "prjtrellis": ("https://prjtrellis.readthedocs.io/en/latest/", None), + "prjxray": ("https://symbiflow.readthedocs.io/projects/prjxray/en/latest/", None), + "vtr": ("https://docs.verilogtorouting.org/en/latest/", None), +} diff --git a/source/fasm b/source/fasm deleted file mode 160000 index 6308864..0000000 --- a/source/fasm +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 6308864592c6aacd5b87de5486b498a6ddde72b1 diff --git a/source/index.rst b/source/index.rst index 7c99cf8..01fe00f 100644 --- a/source/index.rst +++ b/source/index.rst @@ -6,8 +6,8 @@ SymbiFlow documentation :maxdepth: 3 introduction - toolchain-desc - symbiflow-arch-defs/docs/source/index - prjxray/docs/index - prjtrellis/docs/index - fasm/docs/specification + toolchain-desc/index + Architecture Definitions ➚ + Project X-Ray ➚ + Project Trellis ➚ + FPGPA Assembly (FASM) ➚ diff --git a/source/introduction.rst b/source/introduction.rst index 2b87743..e8fe353 100644 --- a/source/introduction.rst +++ b/source/introduction.rst @@ -37,16 +37,16 @@ project for several activities, the central of which pertains to the creation of so-called FPGA "architecture definitions", i.e. documentation of how specific FPGAs work internally. More information can be found in the :doc:`Symbiflow Architecture Definitions -<../symbiflow-arch-defs/docs/source/index>` project. +` project. Those definitions and serve as input to backend tools like `nextpnr `_ and `Verilog to Routing `_, and frontend tools like `Yosys `_. They are created within separate collaborating projects targeting different FPGAs - :doc:`Project X-Ray -<../prjxray/docs/index>` for Xilinx 7-Series, `Project IceStorm +` for Xilinx 7-Series, `Project IceStorm `_ for Lattice iCE40 and :doc:`Project Trellis -<../prjtrellis/docs/index>` for Lattice ECP5 FPGAs. +` for Lattice ECP5 FPGAs. .. figure:: images/parts.svg diff --git a/source/prjtrellis b/source/prjtrellis deleted file mode 160000 index 9b3db7b..0000000 --- a/source/prjtrellis +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 9b3db7ba9a02e7d2f49c52ce062d5b22e320004c diff --git a/source/prjxray b/source/prjxray deleted file mode 160000 index f7f0689..0000000 --- a/source/prjxray +++ /dev/null @@ -1 +0,0 @@ -Subproject commit f7f06896ad26bb7c94680dc323d4b871eded1f4e diff --git a/source/symbiflow-arch-defs b/source/symbiflow-arch-defs deleted file mode 160000 index b483f25..0000000 --- a/source/symbiflow-arch-defs +++ /dev/null @@ -1 +0,0 @@ -Subproject commit b483f25497c4ea8e23916fa6788b85f6f7ea6981 diff --git a/source/toolchain-desc.rst b/source/toolchain-desc/index.rst similarity index 50% rename from source/toolchain-desc.rst rename to source/toolchain-desc/index.rst index 9608ba4..20a272a 100644 --- a/source/toolchain-desc.rst +++ b/source/toolchain-desc/index.rst @@ -7,7 +7,7 @@ as well as the basic concepts of the FPGA design flow. .. toctree:: :maxdepth: 3 - symbiflow-arch-defs/docs/source/getting-started - toolchain-desc/design-flow - toolchain-desc/yosys - vtr-verilog-to-routing/doc/src/vpr/index + Getting started ➚ + design-flow + yosys + VPR ➚ diff --git a/source/vtr-verilog-to-routing b/source/vtr-verilog-to-routing deleted file mode 160000 index d58f993..0000000 --- a/source/vtr-verilog-to-routing +++ /dev/null @@ -1 +0,0 @@ -Subproject commit d58f993d07fe752dbe254132e739ce2d62abc9e5