Extend GHA documentation to specify requirements file

This commit is contained in:
Deniz Turgut 2023-10-29 18:30:25 +03:00
commit 6f1605edf9
No known key found for this signature in database
GPG key ID: 87B7168D7AB3ED2F
2 changed files with 3 additions and 2 deletions

View file

@ -9,7 +9,7 @@ on:
requirements: requirements:
required: false required: false
default: "pelican" default: "pelican"
description: "The Python requirements to install, for example to enable markdown and typogrify use: 'pelican[markdown] typogrify'" description: "The Python requirements to install, for example to enable markdown and typogrify use: 'pelican[markdown] typogrify' or if you have a requirements file use: '-r requirements.txt'"
type: string type: string
output-path: output-path:
required: false required: false
@ -58,4 +58,3 @@ jobs:
- name: Deploy to GitHub Pages - name: Deploy to GitHub Pages
id: deployment id: deployment
uses: actions/deploy-pages@v2 uses: actions/deploy-pages@v2

View file

@ -187,6 +187,8 @@ the workflow:
| | | install, for example to enable | | | | | | install, for example to enable | | |
| | | markdown and typogrify use: | | | | | | markdown and typogrify use: | | |
| | | ``"pelican[markdown] typogrify"`` | | | | | | ``"pelican[markdown] typogrify"`` | | |
| | | or if you have a requirements | | |
| | | file: ``"-r requirements.txt"`` | | |
+--------------+----------+-----------------------------------+--------+---------------+ +--------------+----------+-----------------------------------+--------+---------------+
| output-path | No | Where to output the generated | string | ``"output/"`` | | output-path | No | Where to output the generated | string | ``"output/"`` |
| | | files (``pelican``'s ``--output`` | | | | | | files (``pelican``'s ``--output`` | | |