Migrate to myst-parser for markdown docs

Signed-off-by: Jeff Goeders <[email protected]>

Author: jgoeders

BUILDING.md

@@ -1,232 +1,49 @@
-# Optional Build Information #
+# Building VTR
 
-This page contains additional information about the VTR build system, and how to build VTR on other OS platforms or with non-standard build options.  If you only need to the default features of VTR on a Debian/Ubuntu system, the previous [Building VTR](vtr/get_vtr) page should be sufficient and you can :ref:`skip this page <next>`.  
 
-## Overview ##
+## Setting up Your Environment
 
-VTR uses [CMake](https://cmake.org) as it's build system.
 
-CMake provides a portable cross-platform build systems with many useful features.
+VTR requires several system packages.  From the top-level directory, run the following script to install the required packages on a modern Debian or Ubuntu system:
 
-## Tested Compilers ##
-VTR requires a C++-14 compliant compiler.
-It is tested against the default compilers of all Debian and Ubuntu releases within their standard support lifetime. Currently, those are the following:
+    ./install_apt_packages.sh
 
-* GCC/G++: 7, 8, 9, 10, 11
-* Clang/Clang++: 6, 7, 10
 
-Other compilers may work but are untested (your milage may vary).
+You will also need several Python packages.  You can optionally install and activate a Python virtual environment so that you do not need to modify your system Python installation:
 
-## Unix-like ##
-For unix-like systems we provide a wrapper Makefile which supports the traditional `make` and `make clean` commands, but calls CMake behind the scenes.
+    make env
+    source .venv/bin/activate
 
-### Dependencies ###
+Then to install the Python packages:
 
-For the basic tools you need:
- * Bison & Flex
- * cmake, make
- * A modern C++ compiler supporting C++14 (such as GCC >= 4.9 or clang >= 3.6)
+    pip install -r requirements.txt
 
-For the VPR GUI you need:
- * Cairo
- * FreeType
- * Xft (libXft + libX11)
- * fontconfig
- * libgtk-3-dev
+**Note:** If you chose to install the Python virtual environment, you will need to remember to activate it on any new terminal window you use, before you can run the VTR flow or regressions tests.
 
-For the [regression testing and benchmarking](README.developers.md#running-tests) you will need:
- * Perl + List::MoreUtils
- * Python
- * time
+## Building
 
-It is also recommended you install the following development tools:
- * git
- * ctags
- * gdb
- * valgrind
- * clang-format-7
+From the top-level, run:
 
-For Docs generation you will need:
- * Doxygen
- * python-sphinx
- * python-sphinx-rtd-theme
- * python-recommonmark
+    make
 
-#### Debian & Ubuntu ####
+   which will build all the required tools.
 
+The complete VTR flow has been tested on 64-bit Linux systems.
+The flow should work in other platforms (32-bit Linux, Windows with cygwin) but this is untested.
 
-For documentation generation these additional Python packages are required:
+*See Also:* Full information about building VTR, including setting up required system packages and Python packages, can be found in [Optional Build Information](doc/src/vtr/optional_build_info.md) page.
 
-```shell
-pip install -r doc/requirements.txt
-```
+Please [let us know](doc/src/contact.md) your experience with building VTR so that we can improve the experience for others.
 
-For development the following additional packages are useful:
+The tools included official VTR releases have been tested for compatibility.
+If you download a different version of those tools, then those versions may not be mutually compatible with the VTR release.
 
-```shell
-apt-get install \
-	git \
-	valgrind \
-	gdb \
-	ctags
-```
+## Verifying Installation
 
-#### Using Nix ####
+To verfiy that VTR has been installed correctly run::
 
-Although the recommended platform is Debian or Ubuntu, Nix can be used to build VTR on other platforms, such as MacOS.
+    ./vtr_flow/scripts/run_vtr_task.py basic_flow
 
-If you don't have [Nix](https://nixos.org/nix/), you can [get it](https://nixos.org/nix/download.html) with:
+The expected output is::
 
-```shell
-$ curl -L https://nixos.org/nix/install | sh
-```
-
-These commands will set up dependencies for Linux and MacOS and build VTR:
-
-```shell
-#In the VTR root
-$ nix-shell dev/nix/shell.nix
-$ make
-```
-
-### Building using the Makefile wrapper ###
-Run `make` from the root of the VTR source tree
-
-```shell
-#In the VTR root
-$ make
-...
-[100%] Built target vpr
-```
-
-
-#### Specifying the build type ####
-You can specify the build type by passing the `BUILD_TYPE` parameter.
-
-For instance to create a debug build (no optimization and debug symbols):
-
-```shell
-#In the VTR root
-$ make BUILD_TYPE=debug
-...
-[100%] Built target vpr
-```
-
-
-#### Passing parameters to CMake ####
-You can also pass parameters to CMake.
-
-For instance to set the CMake configuration variable `VTR_ENABLE_SANITIZE` on:
-
-```shell
-#In the VTR root
-$ make CMAKE_PARAMS="-DVTR_ENABLE_SANITIZE=ON"
-...
-[100%] Built target vpr
-```
-
-Both the `BUILD_TYPE` and `CMAKE_PARAMS` can be specified concurrently:
-```shell
-#In the VTR root
-$ make BUILD_TYPE=debug CMAKE_PARAMS="-DVTR_ENABLE_SANITIZE=ON"
-...
-[100%] Built target vpr
-```
-
-
-### Using CMake directly ###
-You can also use cmake directly.
-
-First create a build directory under the VTR root:
-
-```shell
-#In the VTR root
-$ mkdir build
-$ cd build
-
-#Call cmake pointing to the directory containing the root CMakeLists.txt
-$ cmake ..
-
-#Build
-$ make
-```
-
-#### Changing configuration on the command line ####
-You can change the CMake configuration by passing command line parameters.
-
-For instance to set the configuration to debug:
-
-```shell
-#In the build directory
-$ cmake . -DCMAKE_BUILD_TYPE=debug
-
-#Re-build
-$ make
-```
-
-#### Changing configuration interactively with ccmake ####
-You can also use `ccmake` to to modify the build configuration.
-
-```shell
-#From the build directory
-$ ccmake . #Make some configuration change
-
-#Build
-$ make
-```
-
-## Other platforms ##
-
-CMake supports a variety of operating systems and can generate project files for a variety of build systems and IDEs.
-While VTR is developed primarily on Linux, it should be possible to build on different platforms (your milage may vary).
-See the [CMake documentation](https://cmake.org) for more details about using cmake and generating project files on other platforms and build systems (e.g. Eclipse, Microsoft Visual Studio).
-
-
-### Microsoft Windows ###
-
-*NOTE: VTR support on Microsoft Windows is considered experimental*
-
-#### Cygwin ####
-[Cygwin](https://www.cygwin.com/) provides a POSIX (i.e. unix-like) environment for Microsoft Windows.
-
-From within the cygwin terminal follow the Unix-like build instructions listed above.
-
-Note that the generated executables will rely upon Cygwin (e.g. `cygwin1.dll`) for POSIX compatibility.
-
-#### Cross-compiling from Linux to Microsoft Windows with MinGW-W64 ####
-It is possible to cross-compile from a Linux host system to generate Microsoft Windows executables using the [MinGW-W64](https://mingw-w64.org) compilers.
-These can usually be installed with your Linux distribution's package manager (e.g. `sudo apt-get install mingw-w64` on Debian/Ubuntu).
-
-Unlike Cygwin, MinGW executables will depend upon the standard Microsoft Visual C++ run-time.
-
-To build VTR using MinGW:
-```shell
-#In the VTR root
-$ mkdir build_win64
-$ cd build_win64
-
-#Run cmake specifying the toolchain file to setup the cross-compilation environment
-$ cmake .. -DCMAKE_TOOLCHAIN_FILE ../cmake/toolchains/mingw-linux-cross-compile-to-windows.cmake
-
-#Building will produce Windows executables
-$ make
-```
-
-Note that by default the MS Windows target system will need to dynamically link to the `libgcc` and `libstdc++` DLLs.
-These are usually found under /usr/lib/gcc on the Linux host machine.
-
-See the [toolchain file](cmake/toolchains/mingw-linux-cross-compile-to-windows.cmake) for more details.
-
-#### Microsoft Visual Studio ####
-CMake can generate a Microsft Visual Studio project, enabling VTR to be built with the Microsoft Visual C++ (MSVC) compiler.
-
-##### Installing additional tools #####
-VTR depends on some external unix-style tools during it's buid process; in particular the `flex` and `bison` parser generators.
-
-One approach is to install these tools using [MSYS2](http://www.msys2.org/), which provides up-to-date versions of many unix tools for MS Windows.
-
-To ensure CMake can find the `flex` and `bison` executables you must ensure that they are available on your system path.
-For instance, if MSYS2 was installed to `C:\msys64` you would need to ensure that `C:\msys64\usr\bin` was included in the system PATH environment variable.
-
-##### Generating the Visual Studio Project #####
-CMake (e.g. the `cmake-gui`) can then be configured to generate the MSVC project.
+    k6_N10_memSize16384_memData64_40nm_timing/ch_intrinsics...OK

doc/requirements.txt

@@ -2,15 +2,15 @@
 # used by Read The Docs to install python required
 # modules with pip.
 
-Sphinx==3.0
+Sphinx==3.1
 sphinx_rtd_theme
 
 # Support custom domains
 sphinxcontrib-domaintools
 
 # Support Markdown
-recommonmark
 sphinx-markdown-tables
+myst_parser
 
 # Handle markdown cross-references
 git+https://github.com/SymbiFlow/sphinxcontrib-markdown-symlinks

doc/src/BUILDING.md

@@ -0,0 +1,3 @@
+```{include} ../../BUILDING.md
+:relative-docs: doc/src
+```

doc/src/CONTRIBUTING.md

@@ -0,0 +1,2 @@
+```{include} ../../CONTRIBUTING.md
+```

doc/src/README.developers.md

@@ -0,0 +1,2 @@
+```{include} ../../README.developers.md
+```

doc/src/SUPPORT.md

@@ -0,0 +1,2 @@
+```{include} ../../SUPPORT.md
+```

doc/src/conf.py

@@ -18,8 +18,6 @@
 import shutil
 import subprocess
 
-# Markdown support
-import recommonmark
 
 sys.path.append(".")
 sys.path.insert(0, os.path.abspath("../../vtr_flow/scripts/python_libs"))
@@ -67,7 +65,7 @@
     "sdcdomain",
     "archdomain",
     "rrgraphdomain",
-    "recommonmark",
+    "myst_parser",
     "sphinx.ext.autodoc",
     "sphinx.ext.graphviz",
 ]
@@ -373,41 +371,10 @@
         for prjname, prjdir in breathe_projects.items():
             assert os.path.exists(prjdir) == True, "Regenerate doxygen XML for {}".format(prjname)
 
-
-def recommonmark_setup(app):
-    """Initialize Sphinx extension."""
-    import sphinx
-
-    if sphinx.version_info >= (1, 8):
-        app.add_source_suffix(".md", "markdown")
-        app.add_source_parser(LinkParser)
-
-    return {"version": recommonmark.__version__, "parallel_read_safe": True}
-
-
-# Override recommonmark setup
-recommonmark.setup = recommonmark_setup
+# Add page anchors for myst parser
+myst_heading_anchors = 3
 
 
 def setup(app):
-    github_code_repo = "https://github.com/verilog-to-routing/vtr-verilog-to-routing/"
-    github_code_branch = "blob/master/"
-
-    docs_root_dir = os.path.realpath(os.path.dirname(__file__))
-    code_root_dir = os.path.realpath(os.path.join(docs_root_dir, "..", ".."))
 
-    MarkdownSymlinksDomain.init_domain(
-        github_code_repo, github_code_branch, docs_root_dir, code_root_dir
-    )
-    MarkdownSymlinksDomain.find_links()
-    app.add_domain(MarkdownSymlinksDomain)
-    app.add_config_value(
-        "recommonmark_config",
-        {
-            "github_code_repo": github_code_repo,
-            "enable_math": True,
-            "enable_inline_math": True,
-        },
-        True,
-    )
     app.add_stylesheet("css/vtr.css")

doc/src/contact.md

@@ -0,0 +1,27 @@
+
+# Contact
+
+## Mailing Lists
+VTR maintains several mailing lists.
+Most users will be interested in VTR Users and VTR Announce.
+
+* [VTR Announce](https://groups.google.com/forum/#!forum/vtr-announce)
+
+  VTR release announcements (low traffic)
+
+* [VTR Users](https://groups.google.com/forum/#!forum/vtr-users): [email protected]
+
+  Discussions about using the VTR project.
+
+* [VTR Devel](https://groups.google.com/forum/#!forum/vtr-devel): [email protected]
+
+  Discussions about VTR development.
+
+* [VTR Commits](https://groups.google.com/forum/#!forum/vtr-commits):
+
+  Revision Control Commits to the VTR project.
+
+## Issue Tracker
+Please file bugs on our [issue tracker](https://github.com/verilog-to-routing/vtr-verilog-to-routing/issues).
+
+Pull Requests are welcome!