diff --git a/.github/workflows/Test.yml b/.github/workflows/Test.yml index fa1d279..c9bbc4c 100644 --- a/.github/workflows/Test.yml +++ b/.github/workflows/Test.yml @@ -9,28 +9,34 @@ jobs: doc: + if: github.event_name == 'push' && github.ref == 'refs/heads/master' runs-on: ubuntu-latest name: '๐Ÿ““ Docs' + steps: + - name: '๐Ÿงฐ Checkout' + uses: actions/checkout@v4 - - name: '๐Ÿงฐ Checkout' - uses: actions/checkout@v4 + - name: '๐Ÿ Setup Python' + uses: actions/setup-python@v4 + with: + python-version: "3.x" - - name: '๐Ÿ““ BuildTheDocs (BTD)' - uses: buildthedocs/btd@v0 - with: - token: ${{ github.token }} - skip-deploy: ${{ github.event_name == 'pull_request' }} + - name: '๐Ÿ“ฆ Install dependencies' + run: | + pip install sphinx PyYAML tabulate - - name: '๐Ÿงน Clean HTML build' - if: ${{ github.event_name != 'pull_request' }} - run: sudo rm -rf doc/_build/html/.git + - name: '๐Ÿ““ Build docs' + run: | + sphinx-build -b html doc doc/_build/html - - name: '๐Ÿ“ค Upload artifact: HTML' - uses: actions/upload-artifact@v4 - with: - name: openFPGALoader-Documentation - path: doc/_build/html + - name: 'โฌ†๏ธ Deploy to gh-pages' + uses: peaceiris/actions-gh-pages@v4 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: doc/_build/html + publish_branch: gh-pages + keep_files: false lin-build: diff --git a/doc/guide/install.rst b/doc/guide/install.rst index 1f43172..511697f 100644 --- a/doc/guide/install.rst +++ b/doc/guide/install.rst @@ -7,7 +7,7 @@ Linux ===== Debian/Ubuntu ----------- +------------- openFPGALoader is available in the default repositories: diff --git a/doc/vendors/efinix.rst b/doc/vendors/efinix.rst index a47115b..0b64f17 100644 --- a/doc/vendors/efinix.rst +++ b/doc/vendors/efinix.rst @@ -41,11 +41,11 @@ bin file load openFPGALoader --cable jlink_base -m /somewhere/project/outflow/*.bin hex file flash -------------- +-------------- Example for ti60f225. NOTE: JTAG chains with more than one device (eg --index-chain) are currently not supported for writing to SPI flash .. code-block:: bash - openFPGALoader --cable jlink_base --fpga-part ti60f225 -f /somewhere/project/outflow/*.hex \ No newline at end of file + openFPGALoader --cable jlink_base --fpga-part ti60f225 -f /somewhere/project/outflow/*.hex