doc: add Sphinx site and publish it through GitHub Pages

.btd.yml

@@ -0,0 +1,6 @@
+input: doc
+output: _build
+requirements: requirements.txt
+target: gh-pages
+formats: [ html ]
+theme: https://codeload.github.com/buildthedocs/sphinx.theme/tar.gz/v1

.github/workflows/Test.yml

@@ -8,6 +8,26 @@ on:
 jobs:
 
 
+  doc:
+    runs-on: ubuntu-latest
+    name: '📓 Docs'
+    steps:
+
+    - name: '🧰 Checkout'
+      uses: actions/checkout@v2
+
+    - name: '📓 BuildTheDocs (BTD)'
+      uses: buildthedocs/btd@v0
+      with:
+        token: ${{ github.token }}
+        skip-deploy: ${{ github.event_name == 'pull_request' }}
+
+    - name: '📤 Upload artifact: HTML'
+      uses: actions/upload-artifact@v2
+      with:
+        path: doc/_build/html
+
+
   lin-build:
     strategy:
       fail-fast: false

.gitignore

@@ -38,3 +38,6 @@ openFPGALoader
 # Build directory
 build/
 
+# Documentation
+/doc/_build
+/doc/_theme

README.md

@@ -1,46 +1,48 @@
 # openFPGALoader
 
 <p align="right">
-  <a title="'Test' workflow Status" href="https://github.com/trabucayre/openFPGALoader/actions?query=workflow%3ATest"><img alt="'Test' workflow Status" src="https://img.shields.io/github/workflow/status/trabucayre/openFPGALoader/Test?longCache=true&style=flat-square&label=Test&logo=github%20actions&logoColor=fff"></a>
+  <a title="Documentation" href="https://trabucayre.github.io/openFPGALoader"><img src="https://img.shields.io/website.svg?label=trabucayre.github.io%2FopenFPGALoader&longCache=true&style=flat-square&url=http%3A%2F%2Ftrabucayre.github.io%2FopenFPGALoader%2Findex.html&logo=GitHub"></a><!--
+  -->
+  <a title="'Test' workflow Status" href="https://github.com/trabucayre/openFPGALoader/actions?query=workflow%3ATest"><img alt="'Test' workflow Status" src="https://img.shields.io/github/workflow/status/trabucayre/openFPGALoader/Test?longCache=true&style=flat-square&label=Test&logo=github%20actions&logoColor=fff"></a><!--
+  -->
+  <a title="Releases" href="https://github.com/trabucayre/openFPGALoader/releases"><img src="https://img.shields.io/github/commits-since/trabucayre/openFPGALoader/latest.svg?longCache=true&style=flat-square&logo=git&logoColor=fff"></a>
 </p>
 
 <p align="center">
-  <strong><a href="doc/first-steps.md">First steps</a> • <a href="INSTALL.md">Install</a> • <a href="doc/troubleshooting.md">Troubleshooting</a></strong> • <a href="doc/advanced-usage.md">Advanced usage</a>
+  <strong><a href="https://trabucayre.github.io/openFPGALoader/guide/first-steps.html">First steps</a> • <a href="https://trabucayre.github.io/openFPGALoader/guide/install.html">Install</a> • <a href="https://trabucayre.github.io/openFPGALoader/guide/troubleshooting.html">Troubleshooting</a></strong> • <a href="https://trabucayre.github.io/openFPGALoader/guide/advanced.html">Advanced usage</a>
 </p>
 
-Universal utility for programming FPGAs. Compatible with many boards, cables and FPGA from major manufacturers (Xilinx, Altera/Intel, Lattice, Gowin, Efinix, Anlogic). openFPGALoader works on [Linux](INSTALL.md#linux), [Windows](INSTALL.md#windows) and [macOS](INSTALL.md#macos).
+Universal utility for programming FPGAs. Compatible with many boards, cables and FPGA from major manufacturers (Xilinx, Altera/Intel, Lattice, Gowin, Efinix, Anlogic). openFPGALoader works on Linux, Windows and macOS.
 
 Not sure if your hardware is supported? Check the hardware compatibility lists:
 
- * [FPGA compatibility list](doc/fpga-compatibility-list.md)
- * [Board compatibility list](doc/board-compatibility-list.md)
- * [Cable compatibility list](doc/cable-compatibility-list.md)
+ * [FPGA compatibility list](https://trabucayre.github.io/openFPGALoader/compatibility/fpga.html)
+ * [Board compatibility list](https://trabucayre.github.io/openFPGALoader/compatibility/board.html)
+ * [Cable compatibility list](https://trabucayre.github.io/openFPGALoader/compatibility/cable.html)
 
-Also checkout the vendor-specific documentation: [Anlogic](doc/anlogic.md), [Efinix](doc/efinix.md), [Gowin](doc/gowin.md), [Intel/Altera](doc/intel.md), [Lattice](doc/lattice.md), [Xilinx](doc/xilinx.md).
+Also checkout the vendor-specific documentation:
+[Anlogic](https://trabucayre.github.io/openFPGALoader/vendors/anlogic.html),
+[Efinix](https://trabucayre.github.io/openFPGALoader/vendors/efinix.html),
+[Gowin](https://trabucayre.github.io/openFPGALoader/vendors/gowin.html),
+[Intel/Altera](https://trabucayre.github.io/openFPGALoader/vendors/intel.html),
+[Lattice](https://trabucayre.github.io/openFPGALoader/vendors/lattice.html),
+[Xilinx](https://trabucayre.github.io/openFPGALoader/vendors/xilinx.html).
 
 ## Quick Usage
 
-`arty` in the example below is one of the many FPGA board configurations listed [here](doc/board-compatibility-list.md).
+`arty` in the example below is one of the many FPGA board configurations listed [here](https://trabucayre.github.io/openFPGALoader/compatibility/board.html).
 
 ```bash
 openFPGALoader -b arty arty_bitstream.bit # Loading in SRAM
 openFPGALoader -b arty -f arty_bitstream.bit # Writing in flash
 ```
 
-You can also specify a JTAG cable model (complete list [here](doc/cable-compatibility-list.md)) instead of the board model:
+You can also specify a JTAG cable model (complete list [here](https://trabucayre.github.io/openFPGALoader/compatibility/cable.html)) instead of the board model:
 
 ```bash
 openFPGALoader -c cmsisdap fpga_bitstream.bit
 ```
 
-For detailed instructions, by vendor devices, see:
-- [Anlogic](doc/anlogic.md)
-- [Efinix](doc/efinix.md)
-- [Gowin](doc/gowin.md)
-- [Intel/Altera](doc/intel.md)
-- [Lattice](doc/lattice.md)
-- [Xilinx](doc/xilinx.md)
-
 ## Usage
 
 ```
@@ -61,7 +63,7 @@ openFPGALoader -- a program to flash FPGA
       --detect              detect FPGA
       --dfu                 DFU mode
       --dump-flash          Dump flash mode
-      --external-flash      select ext flash for device with internal and  
+      --external-flash      select ext flash for device with internal and
                             external storage
       --file-size arg       provides size in Byte to dump, must be used with
                             dump-flash

doc/Makefile

@@ -0,0 +1,11 @@
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees -T -D language=en $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+%:
+	$(SPHINXBUILD) -b $@ $(ALLSPHINXOPTS) $(BUILDDIR)/$@