From e18a2f1e27cb699c13556181e75d6d3c20683aa6 Mon Sep 17 00:00:00 2001 From: Krystine Sherwin <93062060+KrystalDelusion@users.noreply.github.com> Date: Thu, 22 Aug 2024 10:03:58 +1200 Subject: [PATCH] Docs: Section/folder for yosys source details Move test_suites page into said folder. Placeholder page for building with verific. --- docs/source/getting_started/installation.rst | 5 +++-- docs/source/index.rst | 2 +- docs/source/yosys_source/build_verific.rst | 2 ++ docs/source/yosys_source/index.rst | 7 +++++++ docs/source/{ => yosys_source}/test_suites.rst | 0 5 files changed, 13 insertions(+), 3 deletions(-) create mode 100644 docs/source/yosys_source/build_verific.rst create mode 100644 docs/source/yosys_source/index.rst rename docs/source/{ => yosys_source}/test_suites.rst (100%) diff --git a/docs/source/getting_started/installation.rst b/docs/source/getting_started/installation.rst index aea8b6a2d..76b5aa4fa 100644 --- a/docs/source/getting_started/installation.rst +++ b/docs/source/getting_started/installation.rst @@ -138,7 +138,8 @@ To use a compiler different than the default, use: .. seealso:: - Refer to :doc:`/test_suites` for details on testing Yosys once compiled. + Refer to :doc:`/yosys_source/test_suites` for details on testing Yosys once + compiled. Source tree and build system ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -193,7 +194,7 @@ directories: ``tests/`` This directory contains the suite of unit tests and regression tests used by - Yosys. See :doc:`/test_suites`. + Yosys. See :doc:`/yosys_source/test_suites`. The top-level Makefile includes :file:`frontends/{*}/Makefile.inc`, :file:`passes/{*}/Makefile.inc` and :file:`backends/{*}/Makefile.inc`. So when diff --git a/docs/source/index.rst b/docs/source/index.rst index 582551f74..dd8fc9e77 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -40,6 +40,6 @@ available, go to :ref:`commandindex`. getting_started/index using_yosys/index yosys_internals/index - test_suites + yosys_source/index appendix diff --git a/docs/source/yosys_source/build_verific.rst b/docs/source/yosys_source/build_verific.rst new file mode 100644 index 000000000..4cceb368e --- /dev/null +++ b/docs/source/yosys_source/build_verific.rst @@ -0,0 +1,2 @@ +Compiling with Verific library +------------------------------ diff --git a/docs/source/yosys_source/index.rst b/docs/source/yosys_source/index.rst new file mode 100644 index 000000000..e93b01d4f --- /dev/null +++ b/docs/source/yosys_source/index.rst @@ -0,0 +1,7 @@ +Yosys source details +-------------------- + +.. toctree:: + + build_verific + test_suites diff --git a/docs/source/test_suites.rst b/docs/source/yosys_source/test_suites.rst similarity index 100% rename from docs/source/test_suites.rst rename to docs/source/yosys_source/test_suites.rst