Skip to content

Commit c0cc9f0

Browse files
Add basic Sphinx setup and brief tour documentation
1 parent 1f4e0f0 commit c0cc9f0

31 files changed

+5256
-1
lines changed

Makefile

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.PHONY: help venv conda docker docstyle format style black test lint check coverage
1+
.PHONY: help venv conda docker docstyle format style black test lint check coverage docs
22
.DEFAULT_GOAL = help
33

44
PYTHON = python
@@ -63,6 +63,15 @@ test: # Test code using pytest.
6363
coverage: test
6464
diff-cover coverage.xml --compare-branch=master --fail-under=100
6565

66+
docs:
67+
# latesttag=$(git describe --tags `git rev-list --tags --max-count=1`)
68+
# echo checking out ${latesttag}
69+
# git checkout ${latesttag}
70+
pushd docs && \
71+
make html && \
72+
ghp-import -n -p -r upstream -b gh-pages build/html && \
73+
popd
74+
6675
lint: docstyle format style # Lint code using pydocstyle, black and pylint.
6776

6877
check: lint test coverage # Both lint and test code. Runs `make lint` followed by `make test`.

docs/Makefile

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

docs/logos/PyMC3.ai

Lines changed: 1522 additions & 0 deletions
Large diffs are not rendered by default.

docs/logos/PyMC3.eps

700 KB
Binary file not shown.

docs/logos/PyMC3.ico

4.19 KB
Binary file not shown.

docs/logos/PyMC3.jpg

48 KB
Loading

docs/logos/PyMC3.pdf

296 KB
Binary file not shown.

docs/logos/PyMC3.png

11.3 KB
Loading

docs/logos/svg/PyMC3_banner.svg

Lines changed: 83 additions & 0 deletions
Loading

docs/logos/svg/PyMC3_circle.svg

Lines changed: 67 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)