docs: move DEVELOPMENT.md

Signed-off-by: Unai Martinez-Corral <[email protected]>

Author: umarcor

.github/workflows/tuttest.yml

@@ -5,12 +5,12 @@ on:
     paths:
     - 'syn/symbiflow-yosys/*'
     - '.github/workflows/tuttest.yml'
-    - 'DEVELOPMENT.md'
+    - 'docs/DEVELOPMENT.md'
   push:
     paths:
     - 'syn/symbiflow-yosys/*'
     - '.github/workflows/tuttest.yml'
-    - 'DEVELOPMENT.md'
+    - 'docs/DEVELOPMENT.md'
   workflow_dispatch:
 
 env:
@@ -36,11 +36,11 @@ jobs:
 
       - name: Grab install-prerequisites commands with tuttest
         run: |
-          echo "# DEVELOPMENT.md/install-prerequisites" >$SCRIPT
+          echo "# docs/DEVELOPMENT.md/install-prerequisites" >$SCRIPT
           echo >>$SCRIPT
           # SED changes URL in case the CI is running on a fork
           #   and adds conda-eda as a directory name
-          tuttest DEVELOPMENT.md install-prerequisites | sed -e "s#git clone .*\.git.*#git clone https://github.com/$GITHUB_REPOSITORY.git conda-eda#" >>$SCRIPT
+          tuttest docs/DEVELOPMENT.md install-prerequisites | sed -e "s#git clone .*\.git.*#git clone https://github.com/$GITHUB_REPOSITORY.git conda-eda#" >>$SCRIPT
           echo >>$SCRIPT
 
       - name: Add checkout commands
@@ -57,9 +57,9 @@ jobs:
 
       - name: Grab prepare-and-build commands with tuttest
         run: |
-          echo "# DEVELOPMENT.md/prepare-and-build" >>$SCRIPT
+          echo "# docs/DEVELOPMENT.md/prepare-and-build" >>$SCRIPT
           echo >>$SCRIPT
-          tuttest DEVELOPMENT.md prepare-and-build >>$SCRIPT
+          tuttest docs/DEVELOPMENT.md prepare-and-build >>$SCRIPT
 
       - name: Print ${{ env.SCRIPT }}
         run: cat $SCRIPT

DEVELOPMENT.md renamed to docs/DEVELOPMENT.md

@@ -8,12 +8,20 @@
 extensions = [
     "sphinx.ext.extlinks",
     "sphinx.ext.intersphinx",
+    "myst_parser"
 ]
 
 source_suffix = {
     ".rst": "restructuredtext",
+    ".md": "markdown"
 }
 
+myst_enable_extensions = [
+    "colon_fence",
+]
+
+numfig = True
+
 master_doc = "index"
 project = "Conda recipes for FPGA EDA tools"
 copyright = "2019-2022, hdl/conda-* contributors"

docs/conf.py

@@ -6,8 +6,6 @@ Conda recipes for FPGA EDA tools
    :align: center
    :target: https://github.com/hdl/conda-eda
 
-.. raw:: html
+.. toctree::
 
-    <br>
-
-    <hr>
+  DEVELOPMENT.md

docs/index.rst

@@ -1 +1,2 @@
 sphinx
+myst-parser