Skip to content

Commit 8d16eea

Browse files
committed
Added GitHub Action pipeline for Sphinx documentation.
1 parent 67daf32 commit 8d16eea

File tree

2 files changed

+70
-0
lines changed

2 files changed

+70
-0
lines changed

.github/workflows/Pipeline.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Verify PoC and Generate Documentation
2+
3+
on:
4+
push:
5+
pull_request:
6+
7+
jobs:
8+
Documentation:
9+
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r4
10+
with:
11+
requirements: '-r docs/requirements.txt'
12+
doc_directory: 'docs'
13+
coverage_report_json_directory: "coverage"
14+
html_artifact: 'PoC-HTML'
15+
latex_artifact: 'PoC-LaTeX'
16+
17+
PublishToGitHubPages:
18+
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@dev
19+
needs:
20+
- Documentation
21+
with:
22+
doc: 'PoC-HTML'
23+
coverage: 'PoC-Coverage-HTML'
24+
25+
Release:
26+
uses: pyTooling/Actions/.github/workflows/NightlyRelease.yml@r4
27+
if: startsWith(github.ref, 'refs/tags/v')
28+
needs:
29+
# - Ubuntu
30+
# - Windows
31+
# - PublishCoverageResults
32+
# - PublishTestResults
33+
- PublishToGitHubPages
34+
secrets: inherit
35+
permissions:
36+
contents: write
37+
actions: write
38+
attestations: write
39+
with:
40+
prerelease: true
41+
replacements: |
42+
poc=1.3.0
43+
nightly_name: "v1.3.0"
44+
nightly_description: |
45+
# The PoC-Library %poc%
46+
inventory-json: "inventory.json"
47+
inventory-version: "1.3.0"
48+
assets: |

docs/requirements.txt

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
-r ../requirements.txt
2+
3+
colorama >= 0.4.6
4+
ruamel.yaml ~= 0.18
5+
setuptools ~= 75.8
6+
7+
# Enforce latest version on ReadTheDocs
8+
sphinx ~= 8.2
9+
docutils ~= 0.21
10+
docutils_stubs ~= 0.0.22
11+
12+
# ReadTheDocs Theme
13+
sphinx_rtd_theme ~= 3.0
14+
15+
# Sphinx Extenstions
16+
sphinxcontrib-mermaid ~= 1.0
17+
sphinxcontrib-autoprogram ~= 0.1
18+
autoapi >= 2.0.1
19+
sphinx_design ~= 0.6.1
20+
sphinx-copybutton >= 0.5.2
21+
sphinx_autodoc_typehints ~= 3.1
22+
sphinx_reports ~= 0.7

0 commit comments

Comments
 (0)