github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Extend GHA documentation to specify requirements file

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

3
.github/workflows/github_pages.yml vendored
View file

@ -9,7 +9,7 @@ on:
requirements:
required: false
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
output-path:
required: false
@ -58,4 +58,3 @@ jobs:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2

2
docs/tips.rst
View file

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