doc: try to fix action

This commit is contained in:
Gwenhael Goavec-Merou 2026-02-16 11:01:57 +01:00
parent 206e8b1bc7
commit 67b2cc7d5c
4 changed files with 36 additions and 20 deletions

View File

@ -9,28 +9,44 @@ jobs:
doc:
if: github.event_name == 'push'
runs-on: ubuntu-latest
name: '📓 Docs'
permissions:
contents: read
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
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: '⬆️ Upload Pages artifact'
uses: actions/upload-pages-artifact@v3
with:
path: doc/_build/html
- name: '🚀 Deploy to GitHub Pages'
id: deployment
uses: actions/deploy-pages@v4
lin-build:

View File

@ -7,7 +7,7 @@ Linux
=====
Debian/Ubuntu
----------
-------------
openFPGALoader is available in the default repositories:

View File

@ -1,7 +1,7 @@
.. _troubleshooting:
Troubleshooting
###############
Troubleshooting Guide
#####################
I installed openFPGALoader but it says `command not found` when I try to launch it
==================================================================================

View File

@ -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
openFPGALoader --cable jlink_base --fpga-part ti60f225 -f /somewhere/project/outflow/*.hex