Skip to content

Commit 0a278b6

Browse files
committed
Initial commit
0 parents  commit 0a278b6

24 files changed

+1104
-0
lines changed

.gitignore

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# sphinx build folder
2+
docs/*
3+
4+
# Compiled source #
5+
###################
6+
*.com
7+
*.class
8+
*.dll
9+
*.exe
10+
*.o
11+
*.so
12+
13+
*.doctree
14+
*.pickle
15+
.vscode/*
16+
.idea
17+
*.iml
18+
19+
# macOS specific
20+
.DS_Store

.travis.yml

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
language: python
2+
3+
python:
4+
- 3.8
5+
6+
dist: xenial
7+
sudo: true
8+
9+
stages:
10+
- test-links
11+
- build
12+
- name: deploy
13+
if: branch = master # Deploy only on master commits
14+
15+
install:
16+
- pip install pipenv
17+
- pipenv install
18+
19+
jobs:
20+
include:
21+
- stage: test-links
22+
script: pipenv run make linkcheck
23+
- stage: build
24+
script: pipenv run make html
25+
- stage: deploy
26+
script: pipenv run make html
27+
deploy:
28+
provider: pages
29+
skip-cleanup: true
30+
github-token: $GITHUB_TOKEN # Set in the settings page of your repository, as a secure variable
31+
keep-history: true
32+
local-dir: docs/html
33+
on:
34+
branch: master

Makefile

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS = -Dversion=$(shell git tag --sort=committerdate | tail -1)
6+
SPHINXBUILD = sphinx-build
7+
SOURCEDIR = source
8+
BUILDDIR = docs
9+
10+
# Put it first so that "make" without argument is like "make help".
11+
help:
12+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
13+
14+
.PHONY: help Makefile
15+
16+
# Catch-all target: route all unknown targets to Sphinx using the new
17+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
18+
%: Makefile
19+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

Pipfile

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
[[source]]
2+
name = "pypi"
3+
url = "https://pypi.org/simple"
4+
verify_ssl = true
5+
6+
[packages]
7+
sphinx = "*"
8+
pydata-sphinx-theme = "0.3.1"

Pipfile.lock

+245
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)