Skip to content

Commit

Permalink
Merge pull request #9 from jburel/docs_check
Browse files Browse the repository at this point in the history
add file to build doc in /docs
  • Loading branch information
jburel authored Dec 8, 2020
2 parents c5b2edb + bea60bb commit d3e767c
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
8 changes: 8 additions & 0 deletions workflow-templates/sphinx.properties.json
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"
]
}
34 changes: 34 additions & 0 deletions workflow-templates/sphinx.yml
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 }}

0 comments on commit d3e767c

Please sign in to comment.