Skip to content

Commit 12a322a

Browse files
authored
Merge pull request #121 from ocefpaf/docs
Docs
2 parents 6589f5f + 250da80 commit 12a322a

File tree

3 files changed

+53
-55
lines changed

3 files changed

+53
-55
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Build and Deploy docs
2+
3+
on:
4+
pull_request:
5+
6+
push:
7+
tags:
8+
- "v*"
9+
10+
jobs:
11+
build-docs:
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- name: checkout
16+
uses: actions/checkout@v3
17+
with:
18+
fetch-depth: 0
19+
20+
- name: Setup Mamba
21+
uses: mamba-org/provision-with-micromamba@v14
22+
with:
23+
environment-file: false
24+
25+
- name: Build environment
26+
shell: bash -l {0}
27+
run: |
28+
micromamba create --name TEST python=3 --file requirements.txt --file requirements-dev.txt --channel conda-forge
29+
micromamba activate TEST
30+
python -m pip install -e . --no-deps --force-reinstall
31+
32+
- name: Get the version
33+
id: get_version
34+
run: echo ::set-output name=VERSION::$(python setup.py --version)
35+
36+
- name: Build documentation
37+
shell: bash -l {0}
38+
run: |
39+
set -e
40+
micromamba activate TEST
41+
pushd docs
42+
make clean html linkcheck
43+
popd
44+
45+
- name: Deploy
46+
if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags/v')
47+
uses: peaceiris/actions-gh-pages@v3
48+
with:
49+
github_token: ${{ secrets.GITHUB_TOKEN }}
50+
publish_dir: docs/build/html

.travis.yml

Lines changed: 0 additions & 51 deletions
This file was deleted.

docs/source/conf.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,9 @@
2323
copyright = '2018, Filipe Fernandes'
2424
author = 'Filipe Fernandes'
2525

26-
from branca._version import get_versions
26+
import branca
2727

28-
version = release = get_versions()['version']
29-
del get_versions
28+
version = release = branca.__version__
3029

3130

3231
# -- General configuration ---------------------------------------------------
@@ -64,7 +63,7 @@
6463
#
6564
# This is also used if you do content translation via gettext catalogs.
6665
# Usually you set "language" from the command line for these cases.
67-
language = None
66+
language = "en"
6867

6968
# List of patterns, relative to source directory, that match files and
7069
# directories to ignore when looking for source files.

0 commit comments

Comments
 (0)