Skip to content
This repository has been archived by the owner on Nov 19, 2017. It is now read-only.

Commit

Permalink
Merge branch 'feature/refine-docs' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
tonyseek committed Jun 12, 2014
2 parents 760fdb0 + 5e3a46c commit 7366953
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 19 deletions.
1 change: 0 additions & 1 deletion docs/.gitignore

This file was deleted.

13 changes: 4 additions & 9 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
THEMEDIR = _themes

# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
Expand Down Expand Up @@ -49,22 +48,18 @@ help:

clean:
rm -rf $(BUILDDIR)/*
rm -rf $(THEMEDIR)

$(THEMEDIR):
git clone git://github.com/kennethreitz/kr-sphinx-themes.git $(THEMEDIR)

html: $(THEMEDIR)
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

dirhtml: $(THEMEDIR)
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

singlehtml: $(THEMEDIR)
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
Expand All @@ -79,7 +74,7 @@ json:
@echo
@echo "Build finished; now you can process the JSON files."

htmlhelp: $(THEMEDIR)
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
Expand Down
10 changes: 2 additions & 8 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,8 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys
import os
import sphinx_kr_theme

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('_themes'))
sys.path.insert(0, os.path.abspath('..'))

# -- General configuration ------------------------------------------------

Expand Down Expand Up @@ -115,7 +109,7 @@
}

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ['_themes']
html_theme_path = [sphinx_kr_theme.get_html_theme_path()]

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
Expand Down
8 changes: 7 additions & 1 deletion docs/dev-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,8 @@
-e ..
Sphinx
docutils==0.11
Jinja2==2.7.3
MarkupSafe==0.23
pip-tools==0.3.4
Pygments==1.6
sphinx-kr-theme==0.1.0
Sphinx==1.2.2
2 changes: 2 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
pip-tools==0.3.4
sphinx-kr-theme==0.1.0

0 comments on commit 7366953

Please sign in to comment.