Skip to content

Commit c7a3aa7

Browse files
committed
Add new Sphinx documentation
Initial work thanks to @aanand. Signed-off-by: Ben Firshman <[email protected]>
1 parent 1984f68 commit c7a3aa7

31 files changed

+892
-2137
lines changed

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ dist
1010
html/*
1111

1212
# Compiled Documentation
13-
site/
13+
_build/
1414
README.rst
1515

1616
env/

Dockerfile-docs

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1-
FROM python:2.7
1+
FROM python:3.5
22

33
RUN mkdir /home/docker-py
44
WORKDIR /home/docker-py
55

6+
COPY requirements.txt /home/docker-py/requirements.txt
7+
RUN pip install -r requirements.txt
8+
69
COPY docs-requirements.txt /home/docker-py/docs-requirements.txt
710
RUN pip install -r docs-requirements.txt
811

Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ flake8: build
7474

7575
.PHONY: docs
7676
docs: build-docs
77-
docker run -v `pwd`/docs:/home/docker-py/docs/ -p 8000:8000 docker-py-docs mkdocs serve -a 0.0.0.0:8000
77+
docker run --rm -it -v `pwd`:/home/docker-py docker-py-docs sphinx-build docs ./_build
7878

7979
.PHONY: shell
8080
shell: build

docs-requirements.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
mkdocs==0.15.3
1+
recommonmark==0.4.0
2+
Sphinx==1.4.6

docs/_static/custom.css

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
dl.hide-signature > dt {
2+
display: none;
3+
}

docs/_templates/page.html

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
{% extends "!page.html" %}
2+
{% set css_files = css_files + ["_static/custom.css"] %}

0 commit comments

Comments
 (0)