-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
59 changed files
with
4,919 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
env26/ | ||
*.egg | ||
*.egg-info | ||
*.pyc | ||
.coverage | ||
dist/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
Next release | ||
============ | ||
|
||
- ... | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
_themes | ||
_build/ |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
@import url('default.css'); | ||
body { | ||
background-color: #006339; | ||
} | ||
|
||
div.document { | ||
background-color: #dad3bd; | ||
} | ||
|
||
div.sphinxsidebar h3, h4, h5, a { | ||
color: #127c56 !important; | ||
} | ||
|
||
div.related { | ||
color: #dad3bd !important; | ||
background-color: #00744a; | ||
} | ||
|
||
div.related a { | ||
color: #dad3bd !important; | ||
} | ||
|
||
div.body p, div.body dd, div.body li { | ||
text-align: left; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
# Makefile for Sphinx documentation | ||
# | ||
|
||
# You can set these variables from the command line. | ||
SPHINXOPTS = | ||
SPHINXBUILD = ../env26/bin/sphinx-build | ||
PAPER = | ||
|
||
# Internal variables. | ||
PAPEROPT_a4 = -D latex_paper_size=a4 | ||
PAPEROPT_letter = -D latex_paper_size=letter | ||
ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | ||
|
||
.PHONY: help clean html web pickle htmlhelp latex changes linkcheck | ||
|
||
help: | ||
@echo "Please use \`make <target>' where <target> is one of" | ||
@echo " html to make standalone HTML files" | ||
@echo " pickle to make pickle files (usable by e.g. sphinx-web)" | ||
@echo " htmlhelp to make HTML files and a HTML help project" | ||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" | ||
@echo " changes to make an overview over all changed/added/deprecated items" | ||
@echo " linkcheck to check all external links for integrity" | ||
|
||
clean: | ||
-rm -rf _build/* | ||
|
||
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." | ||
|
||
text: | ||
mkdir -p _build/text _build/doctrees | ||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) _build/text | ||
@echo | ||
@echo "Build finished. The HTML pages are in _build/text." | ||
|
||
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 "to start the sphinx-web server." | ||
|
||
web: pickle | ||
|
||
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." | ||
|
||
latex: | ||
mkdir -p _build/latex _build/doctrees | ||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex | ||
cp _static/*.png _build/latex | ||
./convert_images.sh | ||
cp _static/latex-warning.png _build/latex | ||
cp _static/latex-note.png _build/latex | ||
@echo | ||
@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 | ||
@echo | ||
@echo "The overview file is in _build/changes." | ||
|
||
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." | ||
|
||
epub: | ||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) _build/epub | ||
@echo | ||
@echo "Build finished. The epub file is in _build/epub." | ||
|
||
_themes: | ||
git clone git://github.com/Pylons/pylons_sphinx_theme.git _themes |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
.. _pyramid_zcml_api: | ||
|
||
:mod:`pyramid_zcml` API | ||
----------------------- | ||
|
||
.. automodule:: pyramid_zcml | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,209 @@ | ||
# -*- coding: utf-8 -*- | ||
# | ||
# pyramid_zcml documentation build configuration file | ||
# | ||
# This file is execfile()d with the current directory set to its containing | ||
# dir. | ||
# | ||
# The contents of this file are pickled, so don't put values in the | ||
# namespace that aren't pickleable (module imports are okay, they're | ||
# removed automatically). | ||
# | ||
# All configuration values have a default value; values that are commented | ||
# out serve to show the default value. | ||
|
||
# If your extensions are in another directory, add it here. If the | ||
# directory is relative to the documentation root, use os.path.abspath to | ||
# make it absolute, like shown here. | ||
#sys.path.append(os.path.abspath('some/directory')) | ||
|
||
import sys, os | ||
|
||
parent = os.path.dirname(os.path.dirname(__file__)) | ||
sys.path.append(os.path.abspath(parent)) | ||
wd = os.getcwd() | ||
os.chdir(parent) | ||
os.system('%s setup.py test -q' % sys.executable) | ||
os.chdir(wd) | ||
|
||
for item in os.listdir(parent): | ||
if item.endswith('.egg'): | ||
sys.path.append(os.path.join(parent, item)) | ||
|
||
# General configuration | ||
# --------------------- | ||
|
||
# Add any Sphinx extension module names here, as strings. They can be | ||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | ||
extensions = [ | ||
'sphinx.ext.autodoc', | ||
'sphinx.ext.intersphinx', | ||
] | ||
|
||
# Looks for pyramid's objects | ||
intersphinx_mapping = { | ||
'pyramid': | ||
('http://docs.pylonsproject.org/projects/pyramid/dev/', None)} | ||
|
||
# Add any paths that contain templates here, relative to this directory. | ||
templates_path = ['.templates'] | ||
|
||
# The suffix of source filenames. | ||
source_suffix = '.rst' | ||
|
||
# The master toctree document. | ||
master_doc = 'index' | ||
|
||
# General substitutions. | ||
project = 'pyramid_zcml' | ||
copyright = '2010, Agendaless Consulting <chrism@plope.com>' | ||
|
||
# The default replacements for |version| and |release|, also used in various | ||
# other places throughout the built documents. | ||
# | ||
# The short X.Y version. | ||
version = '0.4' | ||
# The full version, including alpha/beta/rc tags. | ||
release = version | ||
|
||
# There are two options for replacing |today|: either, you set today to | ||
# some non-false value, then it is used: | ||
#today = '' | ||
# Else, today_fmt is used as the format for a strftime call. | ||
today_fmt = '%B %d, %Y' | ||
|
||
# List of documents that shouldn't be included in the build. | ||
#unused_docs = [] | ||
|
||
# List of directories, relative to source directories, that shouldn't be | ||
# searched for source files. | ||
#exclude_dirs = [] | ||
|
||
# The reST default role (used for this markup: `text`) to use for all | ||
# documents. | ||
#default_role = None | ||
|
||
# If true, '()' will be appended to :func: etc. cross-reference text. | ||
#add_function_parentheses = True | ||
|
||
# If true, the current module name will be prepended to all description | ||
# unit titles (such as .. function::). | ||
#add_module_names = True | ||
|
||
# If true, sectionauthor and moduleauthor directives will be shown in the | ||
# output. They are ignored by default. | ||
#show_authors = False | ||
|
||
# The name of the Pygments (syntax highlighting) style to use. | ||
pygments_style = 'sphinx' | ||
|
||
|
||
# Options for HTML output | ||
# ----------------------- | ||
|
||
# Add and use Pylons theme | ||
sys.path.append(os.path.abspath('_themes')) | ||
html_theme_path = ['_themes'] | ||
html_theme = 'pylons' | ||
|
||
# The style sheet to use for HTML and HTML Help pages. A file of that name | ||
# must exist either in Sphinx' static/ path, or in one of the custom paths | ||
# given in html_static_path. | ||
# html_style = 'repoze.css' | ||
|
||
# The name for this set of Sphinx documents. If None, it defaults to | ||
# "<project> v<release> documentation". | ||
#html_title = None | ||
|
||
# A shorter title for the navigation bar. Default is the same as | ||
# html_title. | ||
#html_short_title = None | ||
|
||
# The name of an image file (within the static path) to place at the top of | ||
# the sidebar. | ||
# html_logo = '.static/logo_hi.gif' | ||
|
||
# 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 | ||
# 32x32 pixels large. | ||
#html_favicon = None | ||
|
||
# Add any paths that contain custom static files (such as style sheets) | ||
# 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'] | ||
|
||
# If not '', a 'Last updated on:' timestamp is inserted at every page | ||
# bottom, using the given strftime format. | ||
html_last_updated_fmt = '%b %d, %Y' | ||
|
||
# If true, SmartyPants will be used to convert quotes and dashes to | ||
# typographically correct entities. | ||
#html_use_smartypants = True | ||
|
||
# Custom sidebar templates, maps document names to template names. | ||
#html_sidebars = {} | ||
|
||
# Additional templates that should be rendered to pages, maps page names to | ||
# template names. | ||
#html_additional_pages = {} | ||
|
||
# If false, no module index is generated. | ||
#html_use_modindex = True | ||
|
||
# If false, no index is generated. | ||
#html_use_index = True | ||
|
||
# If true, the index is split into individual pages for each letter. | ||
#html_split_index = False | ||
|
||
# If true, the reST sources are included in the HTML build as | ||
# _sources/<name>. | ||
#html_copy_source = True | ||
|
||
# If true, an OpenSearch description file will be output, and all pages | ||
# will contain a <link> tag referring to it. The value of this option must | ||
# be the base URL from which the finished HTML is served. | ||
#html_use_opensearch = '' | ||
|
||
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). | ||
#html_file_suffix = '' | ||
|
||
# Output file base name for HTML help builder. | ||
htmlhelp_basename = 'atemplatedoc' | ||
|
||
|
||
# Options for LaTeX output | ||
# ------------------------ | ||
|
||
# The paper size ('letter' or 'a4'). | ||
#latex_paper_size = 'letter' | ||
|
||
# The font size ('10pt', '11pt' or '12pt'). | ||
#latex_font_size = '10pt' | ||
|
||
# Grouping the document tree into LaTeX files. List of tuples | ||
# (source start file, target name, title, | ||
# author, document class [howto/manual]). | ||
latex_documents = [ | ||
('index', 'pyramid_zcml.tex', 'pyramid_zcml Documentation', | ||
'Repoze Developers', 'manual'), | ||
] | ||
|
||
# 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' | ||
|
||
# For "manual" documents, if this is true, then toplevel headings are | ||
# parts, not chapters. | ||
#latex_use_parts = False | ||
|
||
# Additional stuff for the LaTeX preamble. | ||
#latex_preamble = '' | ||
|
||
# Documents to append as an appendix to all manuals. | ||
#latex_appendices = [] | ||
|
||
# If false, no module index is generated. | ||
#latex_use_modindex = True |
Oops, something went wrong.