diff options
| author | Rémi Flamary <remi.flamary@gmail.com> | 2023-03-24 10:13:59 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-24 10:13:59 +0100 |
| commit | 981fbe3873d7c1c121499bf83557f6d72425bf69 (patch) | |
| tree | 9a5472b5da421169ccdf7db7a970e6ff261ed5b3 /.github | |
| parent | 897026ea1f5c35ba9e881433bc61490e70776b8c (diff) | |
[WIP] Build donc in GH Action and report warnings + move contributing and code of conduct in documentation (#441)
* use action for doc with wraning visible
* remove space
* remove space again
* test pre commands
* install pot properly
* install compiler...
* try composite action
* remoe warning in sliced exmaple
* pep8
* move contributing and code of conduct
* cleanup
* underline too short
* update quickstart
* replace version selector by static list to avoid jsQuery bug
Diffstat (limited to '.github')
| -rw-r--r-- | .github/CONTRIBUTING.md | 1 | ||||
| -rw-r--r-- | .github/workflows/build_doc.yml | 44 |
2 files changed, 44 insertions, 1 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 9bc8e87..168ffb3 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,4 +1,3 @@ - Contributing to POT =================== diff --git a/.github/workflows/build_doc.yml b/.github/workflows/build_doc.yml new file mode 100644 index 0000000..93bd113 --- /dev/null +++ b/.github/workflows/build_doc.yml @@ -0,0 +1,44 @@ +name: Build doc + +on: + workflow_dispatch: + pull_request: + push: + branches: + - 'master' + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v1 + # Standard drop-in approach that should work for most people. + + - name: Set up Python 3.8 + uses: actions/setup-python@v1 + with: + python-version: 3.8 + + - name: Get Python running + run: | + python -m pip install --user --upgrade --progress-bar off pip + python -m pip install --user --upgrade --progress-bar off -r requirements.txt + python -m pip install --user --upgrade --progress-bar off -r docs/requirements.txt + python -m pip install --user --upgrade --progress-bar off ipython "https://api.github.com/repos/sphinx-gallery/sphinx-gallery/zipball/master" memory_profiler + python -m pip install --user -e . + # Look at what we have and fail early if there is some library conflict + - name: Check installation + run: | + which python + python -c "import ot" + # Build docs + - name: Generate HTML docs + uses: rickstaa/sphinx-action@master + with: + docs-folder: "docs/" + - uses: actions/upload-artifact@v1 + with: + name: Documentation + path: docs/build/html/
\ No newline at end of file |