mirror of
https://github.com/getpelican/pelican.git
synced 2025-10-15 20:28:56 +02:00
Extend GHA documentation to specify requirements file
This commit is contained in:
parent
29185e4ad7
commit
6f1605edf9
2 changed files with 3 additions and 2 deletions
3
.github/workflows/github_pages.yml
vendored
3
.github/workflows/github_pages.yml
vendored
|
|
@ -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
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -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`` | | |
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue