diff --git a/.github/workflows/validate-main.yaml b/.github/workflows/validate-main.yaml index 2e78d32..cba4cd4 100644 --- a/.github/workflows/validate-main.yaml +++ b/.github/workflows/validate-main.yaml @@ -7,18 +7,56 @@ on: branches: [main] jobs: - validate: - runs-on: ubuntu-latest + + validate-matrix-linux: + strategy: + matrix: + os-version: [ubuntu-22.04, ubuntu-24.04] + python-version: [3.11, 3.12] + + runs-on: ${{ matrix.os-version }} + continue-on-error: true + + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python-version }} + + - name: Lint + run: | + python3 -m venv .venv + source .venv/bin/activate + python3 -m pip install pip --upgrade pylint + pylint qdox.py + + - name: Validate + run: | + python3 -m pip install . + mv docs/index.html docs/validate.html + python3 -m qdox --withcss + diff docs/index.html docs/validate.html || (echo '***ERROR***: Did you forget to run `make` before pushing your latest changes?' >/dev/stderr && false) + + validate-matrix-macos: + strategy: + matrix: + os-version: [macos-13, macos-14, macos-15] + python-version: [3.11, 3.12] + + runs-on: ${{ matrix.os-version }} + continue-on-error: true steps: - uses: actions/checkout@v4 - uses: actions/setup-python@v5 with: - python-version: '3.11' + python-version: ${{ matrix.python-version }} - name: Lint run: | - python3 -m pip install --user pip --upgrade pylint + python3 -m venv .venv + source .venv/bin/activate + python3 -m pip install pip --upgrade pylint pylint qdox.py - name: Validate @@ -26,4 +64,34 @@ jobs: python3 -m pip install . mv docs/index.html docs/validate.html python3 -m qdox --withcss - diff docs/index.html docs/validate.html || (echo '***ERROR***: Did you forget to run `make` before pushing your latest changes?' >/dev/stderr;false) + diff docs/index.html docs/validate.html || (echo '***ERROR***: Did you forget to run `make` before pushing your latest changes?' >/dev/stderr && false) + + validate-matrix-windows: + strategy: + matrix: + os-version: [windows-2019, windows-2022] + python-version: [3.11, 3.12] + + runs-on: ${{ matrix.os-version }} + continue-on-error: true + + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python-version }} + + - name: Lint + run: | + python3 -m venv .venv + . .venv/scripts/activate + python3 -m pip install pip --upgrade pylint + pylint qdox.py + + - name: Validate + run: | + python3 -m pip install . + mv docs/index.html docs/validate.html + python3 -m qdox --withcss + diff docs/index.html docs/validate.html || (echo '***ERROR***: Did you forget to run `make` before pushing your latest changes?' >/dev/stderr && false) + diff --git a/docs/index.html b/docs/index.html index 173ead6..495791c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -28,7 +28,7 @@
qdox [OPTION ...]
qdox
command generates the documentation for a simple Python
- project. The formatting is meants to use simple text layout as the input so
- that the input can be used for both Python help()
and the documentation
- pages.
+ project. The formatting is designed to use simple text layout as the input
+ so that the same documentation source can be used for both Python help()
+ output and the documentation pages.
The command loads the module specified in the pyproject.toml
file and
outputs the __doc__
property of the module as the command line
documentation. It then outputs the python functions and constants,
@@ -78,7 +78,8 @@ !!text!!
: Highlight text~~text~~
: __text__
: underline text^word
: superscript word (ends at space)^word
: superscript word (ends at space)+
_word
: subscript word (ends at space)`text`
: code
textprotocol
: //url/
: protocol://url/ formatting with active linkE_ERROR = 1
: | qdox | |
: | 0.0.0a1 | |
: | 0.0.0a2 | |
: | Generate quick documentation for a Python project on GitHub | |
: | David P. Chassin | |
: | David P. Chassin |