-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #9 from jburel/docs_check
add file to build doc in /docs
- Loading branch information
Showing
2 changed files
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"name": "Build Sphinx documentation", | ||
"description": "Build Sphinx documentation contained in the /docs folder.", | ||
"iconName": "python", | ||
"categories": [ | ||
"Python" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Builds the Sphinx documentation in the specified folder. | ||
# Default values are docs/ for the directory where the Sphinx | ||
# documentation is located and true to run linkcheck | ||
# To pass a new folder, set directory_path to the folder path | ||
# Pass the arguments you wish to run, default command is make clean html linkcheck | ||
|
||
--- | ||
name: sphinx | ||
|
||
on: | ||
push: | ||
pull_request: | ||
schedule: | ||
- cron: '0 0 * * 0' | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
env: | ||
directory_path: | ||
sphinx_commands: clean html linkcheck # commands to run. Update accordingly | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: actions/setup-python@v2 | ||
- name: Sphinx install | ||
run: pip install --upgrade sphinx | ||
- name: Set directory | ||
run: | | ||
VAR=${{ env.directory_path }} | ||
echo "docs_dir="${VAR:-./docs} >> $GITHUB_ENV | ||
- name: Build doc | ||
run: | | ||
cd $docs_dir | ||
make ${{ env.sphinx_commands }} |