Permalink
Browse files

Updated docs for new theme

  • Loading branch information...
1 parent 7834c04 commit 1eba089b4d872c9c4a7732614c3fac7f773733e0 @blaflamme blaflamme committed Nov 27, 2010
Showing with 32 additions and 29 deletions.
  1. +1 −1 .gitignore
  2. +25 −22 Makefile
  3. +6 −6 conf.py
View
@@ -1,2 +1,2 @@
-.build/
+_build/
_themes
View
@@ -9,7 +9,7 @@ PAPER =
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = -d .build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
@@ -23,48 +23,51 @@ help:
@echo " linkcheck to check all external links for integrity"
clean:
- -rm -rf .build/*
+ -rm -rf _build/*
-html:
- mkdir -p .build/html .build/doctrees
- $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) .build/html
+html: _themes/
+ mkdir -p _build/html _build/doctrees
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
@echo
- @echo "Build finished. The HTML pages are in .build/html."
+ @echo "Build finished. The HTML pages are in _build/html."
pickle:
- mkdir -p .build/pickle .build/doctrees
- $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) .build/pickle
+ mkdir -p _build/pickle _build/doctrees
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
@echo
@echo "Build finished; now you can process the pickle files or run"
- @echo " sphinx-web .build/pickle"
+ @echo " sphinx-web _build/pickle"
@echo "to start the sphinx-web server."
web: pickle
-htmlhelp:
- mkdir -p .build/htmlhelp .build/doctrees
- $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) .build/htmlhelp
+htmlhelp: _themes/
+ mkdir -p _build/htmlhelp _build/doctrees
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
- ".hhp project file in .build/htmlhelp."
+ ".hhp project file in _build/htmlhelp."
latex:
- mkdir -p .build/latex .build/doctrees
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) .build/latex
+ mkdir -p _build/latex _build/doctrees
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
@echo
- @echo "Build finished; the LaTeX files are in .build/latex."
+ @echo "Build finished; the LaTeX files are in _build/latex."
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
"run these through (pdf)latex."
changes:
- mkdir -p .build/changes .build/doctrees
- $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) .build/changes
+ mkdir -p _build/changes _build/doctrees
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
@echo
- @echo "The overview file is in .build/changes."
+ @echo "The overview file is in _build/changes."
linkcheck:
- mkdir -p .build/linkcheck .build/doctrees
- $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) .build/linkcheck
+ mkdir -p _build/linkcheck _build/doctrees
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
- "or in .build/linkcheck/output.txt."
+ "or in _build/linkcheck/output.txt."
+
+_themes:
+ git clone git://github.com/Pylons/pylons_sphinx_theme.git _themes
View
12 conf.py
@@ -38,7 +38,7 @@
extensions = ['sphinx.ext.autodoc']
# Add any paths that contain templates here, relative to this directory.
-templates_path = ['.templates']
+templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
@@ -105,15 +105,15 @@
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
-#html_title = None
+html_title = 'The Pylons Project Documentation v%s' % release
# A shorter title for the navigation bar. Default is the same as
# html_title.
-#html_short_title = None
+html_short_title = 'Home'
# The name of an image file (within the static path) to place at the top of
# the sidebar.
-# html_logo = '.static/logo_hi.gif'
+html_logo = '_static/pylons.png'
# The name of an image file (within the static path) to use as favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or
@@ -124,7 +124,7 @@
# here, relative to this directory. They are copied after the builtin
# static files, so a file named "default.css" will overwrite the builtin
# "default.css".
-html_static_path = ['.static']
+html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format.
@@ -185,7 +185,7 @@
# The name of an image file (relative to this directory) to place at the
# top of the title page.
-latex_logo = '.static/logo_hi.gif'
+latex_logo = '_static/pylons_small.png'
# For "manual" documents, if this is true, then toplevel headings are
# parts, not chapters.

0 comments on commit 1eba089

Please sign in to comment.