Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
csst-pipeline
msc
sextractor
Commits
78282aac
Commit
78282aac
authored
Mar 09, 2023
by
Emmanuel Bertin
Browse files
Add documentation GitHub action workflow.
parent
99c3353a
Changes
2
Show whitespace changes
Inline
Side-by-side
.github/workflows/doc.yml
0 → 100644
View file @
78282aac
name
:
doc
on
:
push
:
paths
:
-
'
doc/**'
pull_request
:
paths
:
-
'
doc/**'
workflow_dispatch
:
jobs
:
#############
# Build doc #
#############
build
:
name
:
Make HTML doc
continue-on-error
:
false
runs-on
:
ubuntu-latest
steps
:
-
name
:
Checkout
uses
:
actions/checkout@v2
-
name
:
Install dependencies
run
:
|
pip3 install -r doc/requirements.txt
-
name
:
Build doc
run
:
|
./autogen.sh
./configure
cd doc
make html
-
name
:
Set destination dir
if
:
github.ref_name != 'main'
run
:
|
echo "DOC_DEST=${{ github.ref_name }}" >> $GITHUB_ENV
-
name
:
Deploy
if
:
success()
uses
:
peaceiris/actions-gh-pages@v3
with
:
publish_branch
:
doc-pages
github_token
:
${{ secrets.GITHUB_TOKEN }}
publish_dir
:
doc/build/html/
destination_dir
:
${{ env.DOC_DEST }}
doc/src/conf.py
View file @
78282aac
...
...
@@ -69,7 +69,7 @@ release = '2.28.0'
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#
today
=
'Tu
e
Mar 0
7
2023'
today
=
'T
h
u Mar 0
9
2023'
#
# Else, today_fmt is used as the format for a strftime call.
#
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment