Skip to content

Commit 917c9a7

Browse files
authored
Add circleci config (#2)
* Add circleci config * Add link.yml * sudo * Add comment on why sudo is required * Add fake setup * comment out html_static_path to suppress warning * Change theme to sphinx_rtd_theme
1 parent 6a2af18 commit 917c9a7

File tree

4 files changed

+41
-2
lines changed

4 files changed

+41
-2
lines changed

.circleci/config.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
version: 2.1
2+
3+
jobs:
4+
document:
5+
docker:
6+
- image: circleci/python:3.7
7+
steps:
8+
- checkout
9+
- run:
10+
name: Install dependencies
11+
# Without `sudo`, `pip install` fails `sudo` due to a permission related issue.
12+
command: sudo pip install -e ".[dev]"
13+
- run:
14+
name: Build documentation
15+
command: cd docs && make html
16+
17+
- store_artifacts:
18+
path: ./docs/build/html
19+
20+
workflows:
21+
main:
22+
jobs:
23+
- document

.github/workflows/link.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Link
2+
3+
on: status
4+
5+
jobs:
6+
doc-link:
7+
runs-on: ubuntu-latest
8+
if: "github.event.context == 'ci/circleci: document'"
9+
steps:
10+
- uses: larsoner/circleci-artifacts-redirector-action@master
11+
with:
12+
repo-token: ${{ secrets.GITHUB_TOKEN }}
13+
artifact-path: 0/docs/build/html/index.html
14+
circleci-jobs: document

docs/source/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@
4949
# The theme to use for HTML and HTML Help pages. See the documentation for
5050
# a list of builtin themes.
5151
#
52-
html_theme = "alabaster"
52+
html_theme = "sphinx_rtd_theme"
5353

5454
# Add any paths that contain custom static files (such as style sheets) here,
5555
# relative to this directory. They are copied after the builtin static files,
5656
# so a file named "default.css" will overwrite the builtin "default.css".
57-
html_static_path = ["_static"]
57+
# html_static_path = ["_static"]
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
def setup(app):
2+
pass

0 commit comments

Comments
 (0)