From 1850856e3b3005d542a4ec9103141082549bc5e4 Mon Sep 17 00:00:00 2001
From: Unai Martinez-Corral <umartinezcorral@antmicro.com>
Date: Sun, 13 Feb 2022 21:43:00 +0100
Subject: [PATCH] docs/building-examples: move additional basys3; update
 heading levels

Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
---
 .github/scripts/build-examples.sh |  4 ++--
 docs/basys3.rst                   |  9 +++++++++
 docs/building-examples.rst        | 19 +++----------------
 docs/index.rst                    |  1 +
 4 files changed, 15 insertions(+), 18 deletions(-)
 create mode 100644 docs/basys3.rst

diff --git a/.github/scripts/build-examples.sh b/.github/scripts/build-examples.sh
index b471757..dcbf383 100755
--- a/.github/scripts/build-examples.sh
+++ b/.github/scripts/build-examples.sh
@@ -55,7 +55,7 @@ fi
 # activate conda and enter example dir
 activate_env="docs/building-examples.rst:export-install-dir,fpga-fam-$fpga_family,conda-prep-env-$fpga_family,conda-act-env"
 snippets="${activate_env},enter-dir-$fpga_family"
-additionalDesigns="${activate_env},enter-dir-$fpga_family,additional_examples"
+additionalDesigns="${activate_env},enter-dir-$fpga_family"
 
 
 # Xilinx 7-Series examples
@@ -80,7 +80,7 @@ if [ "$fpga_family" = "xc7" ]; then
 
             #Additional examples:
             "button_controller")
-                snippets="${additionalDesigns} xc7/additional_examples/button_controller/README.rst:example-debouncer-basys3"
+                snippets="${additionalDesigns} xc7/additional_examples/button_controller/README.rst:additional-examples,example-debouncer-basys3"
                 ;;
             "pulse_width_led")
                 snippets="${snippets} xc7/pulse_width_led/README.rst:example-pulse-arty-35t"
diff --git a/docs/basys3.rst b/docs/basys3.rst
new file mode 100644
index 0000000..5f905dc
--- /dev/null
+++ b/docs/basys3.rst
@@ -0,0 +1,9 @@
+Additional Basys3 Examples
+==========================
+
+You can find several other exciting designs for the basys3 board in the additional_examples directory:
+
+.. code-block:: bash
+   :name: additional_examples
+
+   cd additional_examples
diff --git a/docs/building-examples.rst b/docs/building-examples.rst
index ab6ad1f..d284094 100644
--- a/docs/building-examples.rst
+++ b/docs/building-examples.rst
@@ -1,7 +1,7 @@
 .. _Building-Examples:
 
 Building example designs
-========================
+########################
 
 Before building any example, set the installation directory to match what you
 set it to earlier, for example:
@@ -76,7 +76,7 @@ Finally, enter your working Conda environment:
 
 
 Xilinx 7-Series
----------------
+===============
 
 Enter the directory that contains examples for Xilinx 7-Series FPGAs:
 
@@ -104,21 +104,8 @@ Enter the directory that contains examples for Xilinx 7-Series FPGAs:
    :file: templates/example.jinja
 
 
-
-Additional Examples
--------------------
-
-In addition to the designs we have gone over here, you can also find several other exciting designs
-for the basys3 board in the additional_examples directory:
-
-.. code-block:: bash
-   :name: additional_examples
-
-   cd additional_examples
-
-
 QuickLogic EOS S3
------------------
+=================
 
 Enter the directory that contains examples for QuickLogic EOS S3:
 
diff --git a/docs/index.rst b/docs/index.rst
index 090ef8a..0f20f2f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -49,3 +49,4 @@ currently targeting chips from multiple vendors, e.g.:
    :caption: Additional example designs
 
    project-f
+   basys3