kelp 0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +5 -0
- data/Gemfile +12 -0
- data/Gemfile.lock +91 -0
- data/MIT-LICENSE +22 -0
- data/README.md +16 -0
- data/Rakefile +16 -0
- data/docs/Makefile +130 -0
- data/docs/_static/custom.css +9 -0
- data/docs/conf.py +217 -0
- data/docs/development.rst +27 -0
- data/docs/future.rst +9 -0
- data/docs/index.rst +33 -0
- data/docs/make.bat +155 -0
- data/docs/testing.rst +15 -0
- data/docs/usage.rst +85 -0
- data/kelp.gemspec +25 -0
- data/lib/kelp.rb +1 -0
- data/lib/kelp/capybara.rb +2 -0
- data/lib/kelp/capybara/capybara_steps.rb +225 -0
- data/lib/kelp/capybara/form_helper.rb +131 -0
- data/lib/kelp/capybara/web_helper.rb +148 -0
- data/spec/capybara/click_link_in_row_spec.rb +24 -0
- data/spec/capybara/dropdown_spec.rb +112 -0
- data/spec/capybara/field_should_be_empty_spec.rb +44 -0
- data/spec/capybara/field_should_contain_spec.rb +143 -0
- data/spec/capybara/fill_in_fields_spec.rb +67 -0
- data/spec/capybara/follow_spec.rb +35 -0
- data/spec/capybara/page_should_have_spec.rb +48 -0
- data/spec/capybara/page_should_not_have_spec.rb +53 -0
- data/spec/capybara/press_spec.rb +33 -0
- data/spec/capybara/should_be_disabled_spec.rb +28 -0
- data/spec/capybara/should_be_enabled_spec.rb +29 -0
- data/spec/capybara/should_not_see_spec.rb +97 -0
- data/spec/capybara/should_see_in_same_row_spec.rb +41 -0
- data/spec/capybara/should_see_spec.rb +80 -0
- data/spec/capybara/spec_helper.rb +22 -0
- data/spec/test_app/test_app.rb +18 -0
- data/spec/test_app/views/about.erb +9 -0
- data/spec/test_app/views/edit1.erb +9 -0
- data/spec/test_app/views/edit2.erb +9 -0
- data/spec/test_app/views/edit3.erb +9 -0
- data/spec/test_app/views/form.erb +38 -0
- data/spec/test_app/views/home.erb +46 -0
- data/spec/test_app/views/thanks.erb +10 -0
- metadata +183 -0
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,91 @@
|
|
1
|
+
GEM
|
2
|
+
remote: http://rubygems.org/
|
3
|
+
specs:
|
4
|
+
abstract (1.0.0)
|
5
|
+
actionpack (3.0.3)
|
6
|
+
activemodel (= 3.0.3)
|
7
|
+
activesupport (= 3.0.3)
|
8
|
+
builder (~> 2.1.2)
|
9
|
+
erubis (~> 2.6.6)
|
10
|
+
i18n (~> 0.4)
|
11
|
+
rack (~> 1.2.1)
|
12
|
+
rack-mount (~> 0.6.13)
|
13
|
+
rack-test (~> 0.5.6)
|
14
|
+
tzinfo (~> 0.3.23)
|
15
|
+
activemodel (3.0.3)
|
16
|
+
activesupport (= 3.0.3)
|
17
|
+
builder (~> 2.1.2)
|
18
|
+
i18n (~> 0.4)
|
19
|
+
activesupport (3.0.3)
|
20
|
+
builder (2.1.2)
|
21
|
+
capybara (0.4.0)
|
22
|
+
celerity (>= 0.7.9)
|
23
|
+
culerity (>= 0.2.4)
|
24
|
+
mime-types (>= 1.16)
|
25
|
+
nokogiri (>= 1.3.3)
|
26
|
+
rack (>= 1.0.0)
|
27
|
+
rack-test (>= 0.5.4)
|
28
|
+
selenium-webdriver (>= 0.0.27)
|
29
|
+
xpath (~> 0.1.2)
|
30
|
+
celerity (0.8.5)
|
31
|
+
childprocess (0.1.4)
|
32
|
+
ffi (~> 0.6.3)
|
33
|
+
culerity (0.2.12)
|
34
|
+
diff-lcs (1.1.2)
|
35
|
+
erubis (2.6.6)
|
36
|
+
abstract (>= 1.0.0)
|
37
|
+
ffi (0.6.3)
|
38
|
+
rake (>= 0.8.7)
|
39
|
+
i18n (0.5.0)
|
40
|
+
json_pure (1.4.6)
|
41
|
+
mime-types (1.16)
|
42
|
+
nokogiri (1.4.4)
|
43
|
+
rack (1.2.1)
|
44
|
+
rack-mount (0.6.13)
|
45
|
+
rack (>= 1.0.0)
|
46
|
+
rack-test (0.5.6)
|
47
|
+
rack (>= 1.0)
|
48
|
+
railties (3.0.3)
|
49
|
+
actionpack (= 3.0.3)
|
50
|
+
activesupport (= 3.0.3)
|
51
|
+
rake (>= 0.8.7)
|
52
|
+
thor (~> 0.14.4)
|
53
|
+
rake (0.8.7)
|
54
|
+
rcov (0.9.9)
|
55
|
+
rspec (2.2.0)
|
56
|
+
rspec-core (~> 2.2)
|
57
|
+
rspec-expectations (~> 2.2)
|
58
|
+
rspec-mocks (~> 2.2)
|
59
|
+
rspec-core (2.2.1)
|
60
|
+
rspec-expectations (2.2.0)
|
61
|
+
diff-lcs (~> 1.1.2)
|
62
|
+
rspec-mocks (2.2.0)
|
63
|
+
rspec-rails (2.2.1)
|
64
|
+
actionpack (~> 3.0)
|
65
|
+
activesupport (~> 3.0)
|
66
|
+
railties (~> 3.0)
|
67
|
+
rspec (~> 2.2.0)
|
68
|
+
rubyzip (0.9.4)
|
69
|
+
selenium-webdriver (0.1.1)
|
70
|
+
childprocess (= 0.1.4)
|
71
|
+
ffi (~> 0.6.3)
|
72
|
+
json_pure
|
73
|
+
rubyzip
|
74
|
+
sinatra (1.1.0)
|
75
|
+
rack (~> 1.1)
|
76
|
+
tilt (~> 1.1)
|
77
|
+
thor (0.14.6)
|
78
|
+
tilt (1.1)
|
79
|
+
tzinfo (0.3.23)
|
80
|
+
xpath (0.1.2)
|
81
|
+
nokogiri (~> 1.3)
|
82
|
+
|
83
|
+
PLATFORMS
|
84
|
+
ruby
|
85
|
+
|
86
|
+
DEPENDENCIES
|
87
|
+
capybara (>= 0.4.0)
|
88
|
+
rcov
|
89
|
+
rspec (>= 2.2.0)
|
90
|
+
rspec-rails
|
91
|
+
sinatra
|
data/MIT-LICENSE
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
The MIT License
|
2
|
+
|
3
|
+
Copyright (c) 2010 Eric Pierce
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
Kelp
|
2
|
+
====
|
3
|
+
|
4
|
+
This project aims to package a collection of useful helper methods for
|
5
|
+
Cucumber. Currently, the provided methods depend on Capybara, though support
|
6
|
+
may eventually be added for Webrat, email-spec, or related tools.
|
7
|
+
|
8
|
+
[Read the docs](http://kelp.rtfd.org/) online or view the raw documentation in
|
9
|
+
the `docs` folder.
|
10
|
+
|
11
|
+
Copyright
|
12
|
+
---------
|
13
|
+
|
14
|
+
Copyright (c) 2010 Eric Pierce, released under the MIT license.
|
15
|
+
See MIT-LICENSE for details.
|
16
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'rspec/core/rake_task'
|
3
|
+
|
4
|
+
RSpec::Core::RakeTask.new do |spec|
|
5
|
+
spec.pattern = 'spec/**/*_spec.rb'
|
6
|
+
spec.rspec_opts = ['--color', '--format doc']
|
7
|
+
end
|
8
|
+
|
9
|
+
desc "Generate RCov coverage report"
|
10
|
+
RSpec::Core::RakeTask.new(:rcov) do |spec|
|
11
|
+
spec.pattern = 'spec/**/*_spec.rb'
|
12
|
+
spec.rspec_opts = ['--color', '--format doc']
|
13
|
+
spec.rcov = true
|
14
|
+
spec.rcov_opts = %w{--exclude osx\/objc,gems\/,spec\/,features\/}
|
15
|
+
end
|
16
|
+
|
data/docs/Makefile
ADDED
@@ -0,0 +1,130 @@
|
|
1
|
+
# Makefile for Sphinx documentation
|
2
|
+
#
|
3
|
+
|
4
|
+
# You can set these variables from the command line.
|
5
|
+
SPHINXOPTS =
|
6
|
+
SPHINXBUILD = sphinx-build
|
7
|
+
PAPER =
|
8
|
+
BUILDDIR = _build
|
9
|
+
|
10
|
+
# Internal variables.
|
11
|
+
PAPEROPT_a4 = -D latex_paper_size=a4
|
12
|
+
PAPEROPT_letter = -D latex_paper_size=letter
|
13
|
+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
14
|
+
|
15
|
+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
|
16
|
+
|
17
|
+
help:
|
18
|
+
@echo "Please use \`make <target>' where <target> is one of"
|
19
|
+
@echo " html to make standalone HTML files"
|
20
|
+
@echo " dirhtml to make HTML files named index.html in directories"
|
21
|
+
@echo " singlehtml to make a single large HTML file"
|
22
|
+
@echo " pickle to make pickle files"
|
23
|
+
@echo " json to make JSON files"
|
24
|
+
@echo " htmlhelp to make HTML files and a HTML help project"
|
25
|
+
@echo " qthelp to make HTML files and a qthelp project"
|
26
|
+
@echo " devhelp to make HTML files and a Devhelp project"
|
27
|
+
@echo " epub to make an epub"
|
28
|
+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
29
|
+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
30
|
+
@echo " text to make text files"
|
31
|
+
@echo " man to make manual pages"
|
32
|
+
@echo " changes to make an overview of all changed/added/deprecated items"
|
33
|
+
@echo " linkcheck to check all external links for integrity"
|
34
|
+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
35
|
+
|
36
|
+
clean:
|
37
|
+
-rm -rf $(BUILDDIR)/*
|
38
|
+
|
39
|
+
html:
|
40
|
+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
41
|
+
@echo
|
42
|
+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
43
|
+
|
44
|
+
dirhtml:
|
45
|
+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
46
|
+
@echo
|
47
|
+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
48
|
+
|
49
|
+
singlehtml:
|
50
|
+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
51
|
+
@echo
|
52
|
+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
53
|
+
|
54
|
+
pickle:
|
55
|
+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
56
|
+
@echo
|
57
|
+
@echo "Build finished; now you can process the pickle files."
|
58
|
+
|
59
|
+
json:
|
60
|
+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
61
|
+
@echo
|
62
|
+
@echo "Build finished; now you can process the JSON files."
|
63
|
+
|
64
|
+
htmlhelp:
|
65
|
+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
66
|
+
@echo
|
67
|
+
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
68
|
+
".hhp project file in $(BUILDDIR)/htmlhelp."
|
69
|
+
|
70
|
+
qthelp:
|
71
|
+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
72
|
+
@echo
|
73
|
+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
74
|
+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
75
|
+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Kelp.qhcp"
|
76
|
+
@echo "To view the help file:"
|
77
|
+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Kelp.qhc"
|
78
|
+
|
79
|
+
devhelp:
|
80
|
+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
81
|
+
@echo
|
82
|
+
@echo "Build finished."
|
83
|
+
@echo "To view the help file:"
|
84
|
+
@echo "# mkdir -p $$HOME/.local/share/devhelp/Kelp"
|
85
|
+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Kelp"
|
86
|
+
@echo "# devhelp"
|
87
|
+
|
88
|
+
epub:
|
89
|
+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
90
|
+
@echo
|
91
|
+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
92
|
+
|
93
|
+
latex:
|
94
|
+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
95
|
+
@echo
|
96
|
+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
97
|
+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
98
|
+
"(use \`make latexpdf' here to do that automatically)."
|
99
|
+
|
100
|
+
latexpdf:
|
101
|
+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
102
|
+
@echo "Running LaTeX files through pdflatex..."
|
103
|
+
make -C $(BUILDDIR)/latex all-pdf
|
104
|
+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
105
|
+
|
106
|
+
text:
|
107
|
+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
108
|
+
@echo
|
109
|
+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
110
|
+
|
111
|
+
man:
|
112
|
+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
113
|
+
@echo
|
114
|
+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
115
|
+
|
116
|
+
changes:
|
117
|
+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
118
|
+
@echo
|
119
|
+
@echo "The overview file is in $(BUILDDIR)/changes."
|
120
|
+
|
121
|
+
linkcheck:
|
122
|
+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
123
|
+
@echo
|
124
|
+
@echo "Link check complete; look for any errors in the above output " \
|
125
|
+
"or in $(BUILDDIR)/linkcheck/output.txt."
|
126
|
+
|
127
|
+
doctest:
|
128
|
+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
129
|
+
@echo "Testing of doctests in the sources finished, look at the " \
|
130
|
+
"results in $(BUILDDIR)/doctest/output.txt."
|
data/docs/conf.py
ADDED
@@ -0,0 +1,217 @@
|
|
1
|
+
# -*- coding: utf-8 -*-
|
2
|
+
#
|
3
|
+
# Kelp documentation build configuration file, created by
|
4
|
+
# sphinx-quickstart on Sun Dec 12 16:07:03 2010.
|
5
|
+
#
|
6
|
+
# This file is execfile()d with the current directory set to its containing dir.
|
7
|
+
#
|
8
|
+
# Note that not all possible configuration values are present in this
|
9
|
+
# autogenerated file.
|
10
|
+
#
|
11
|
+
# All configuration values have a default; values that are commented out
|
12
|
+
# serve to show the default.
|
13
|
+
|
14
|
+
import sys, os
|
15
|
+
|
16
|
+
# If extensions (or modules to document with autodoc) are in another directory,
|
17
|
+
# add these directories to sys.path here. If the directory is relative to the
|
18
|
+
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
19
|
+
#sys.path.insert(0, os.path.abspath('.'))
|
20
|
+
|
21
|
+
# -- General configuration -----------------------------------------------------
|
22
|
+
|
23
|
+
# If your documentation needs a minimal Sphinx version, state it here.
|
24
|
+
#needs_sphinx = '1.0'
|
25
|
+
|
26
|
+
# Add any Sphinx extension module names here, as strings. They can be extensions
|
27
|
+
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
28
|
+
extensions = []
|
29
|
+
|
30
|
+
# Add any paths that contain templates here, relative to this directory.
|
31
|
+
templates_path = ['_templates']
|
32
|
+
|
33
|
+
# The suffix of source filenames.
|
34
|
+
source_suffix = '.rst'
|
35
|
+
|
36
|
+
# The encoding of source files.
|
37
|
+
#source_encoding = 'utf-8-sig'
|
38
|
+
|
39
|
+
# The master toctree document.
|
40
|
+
master_doc = 'index'
|
41
|
+
|
42
|
+
# General information about the project.
|
43
|
+
project = u'Kelp'
|
44
|
+
copyright = u'2010, Eric Pierce'
|
45
|
+
|
46
|
+
# The version info for the project you're documenting, acts as replacement for
|
47
|
+
# |version| and |release|, also used in various other places throughout the
|
48
|
+
# built documents.
|
49
|
+
#
|
50
|
+
# The short X.Y version.
|
51
|
+
version = '0.1.1'
|
52
|
+
# The full version, including alpha/beta/rc tags.
|
53
|
+
release = '0.1.1'
|
54
|
+
|
55
|
+
# The language for content autogenerated by Sphinx. Refer to documentation
|
56
|
+
# for a list of supported languages.
|
57
|
+
#language = None
|
58
|
+
|
59
|
+
# There are two options for replacing |today|: either, you set today to some
|
60
|
+
# non-false value, then it is used:
|
61
|
+
#today = ''
|
62
|
+
# Else, today_fmt is used as the format for a strftime call.
|
63
|
+
#today_fmt = '%B %d, %Y'
|
64
|
+
|
65
|
+
# List of patterns, relative to source directory, that match files and
|
66
|
+
# directories to ignore when looking for source files.
|
67
|
+
exclude_patterns = ['_build']
|
68
|
+
|
69
|
+
# The reST default role (used for this markup: `text`) to use for all documents.
|
70
|
+
#default_role = None
|
71
|
+
|
72
|
+
# If true, '()' will be appended to :func: etc. cross-reference text.
|
73
|
+
#add_function_parentheses = True
|
74
|
+
|
75
|
+
# If true, the current module name will be prepended to all description
|
76
|
+
# unit titles (such as .. function::).
|
77
|
+
#add_module_names = True
|
78
|
+
|
79
|
+
# If true, sectionauthor and moduleauthor directives will be shown in the
|
80
|
+
# output. They are ignored by default.
|
81
|
+
#show_authors = False
|
82
|
+
|
83
|
+
# The name of the Pygments (syntax highlighting) style to use.
|
84
|
+
pygments_style = 'sphinx'
|
85
|
+
|
86
|
+
# A list of ignored prefixes for module index sorting.
|
87
|
+
#modindex_common_prefix = []
|
88
|
+
|
89
|
+
|
90
|
+
# -- Options for HTML output ---------------------------------------------------
|
91
|
+
|
92
|
+
# The theme to use for HTML and HTML Help pages. See the documentation for
|
93
|
+
# a list of builtin themes.
|
94
|
+
html_theme = 'sphinxdoc'
|
95
|
+
|
96
|
+
# Theme options are theme-specific and customize the look and feel of a theme
|
97
|
+
# further. For a list of options available for each theme, see the
|
98
|
+
# documentation.
|
99
|
+
#html_theme_options = {}
|
100
|
+
|
101
|
+
# Add any paths that contain custom themes here, relative to this directory.
|
102
|
+
#html_theme_path = []
|
103
|
+
|
104
|
+
# The name for this set of Sphinx documents. If None, it defaults to
|
105
|
+
# "<project> v<release> documentation".
|
106
|
+
#html_title = None
|
107
|
+
|
108
|
+
# A shorter title for the navigation bar. Default is the same as html_title.
|
109
|
+
#html_short_title = None
|
110
|
+
|
111
|
+
# The name of an image file (relative to this directory) to place at the top
|
112
|
+
# of the sidebar.
|
113
|
+
#html_logo = None
|
114
|
+
|
115
|
+
# The name of an image file (within the static path) to use as favicon of the
|
116
|
+
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
117
|
+
# pixels large.
|
118
|
+
#html_favicon = None
|
119
|
+
|
120
|
+
# Add any paths that contain custom static files (such as style sheets) here,
|
121
|
+
# relative to this directory. They are copied after the builtin static files,
|
122
|
+
# so a file named "default.css" will overwrite the builtin "default.css".
|
123
|
+
html_static_path = ['_static']
|
124
|
+
html_style = 'custom.css'
|
125
|
+
|
126
|
+
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
127
|
+
# using the given strftime format.
|
128
|
+
#html_last_updated_fmt = '%b %d, %Y'
|
129
|
+
|
130
|
+
# If true, SmartyPants will be used to convert quotes and dashes to
|
131
|
+
# typographically correct entities.
|
132
|
+
#html_use_smartypants = True
|
133
|
+
|
134
|
+
# Custom sidebar templates, maps document names to template names.
|
135
|
+
#html_sidebars = {}
|
136
|
+
|
137
|
+
# Additional templates that should be rendered to pages, maps page names to
|
138
|
+
# template names.
|
139
|
+
#html_additional_pages = {}
|
140
|
+
|
141
|
+
# If false, no module index is generated.
|
142
|
+
#html_domain_indices = True
|
143
|
+
|
144
|
+
# If false, no index is generated.
|
145
|
+
#html_use_index = True
|
146
|
+
|
147
|
+
# If true, the index is split into individual pages for each letter.
|
148
|
+
#html_split_index = False
|
149
|
+
|
150
|
+
# If true, links to the reST sources are added to the pages.
|
151
|
+
#html_show_sourcelink = True
|
152
|
+
|
153
|
+
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
154
|
+
#html_show_sphinx = True
|
155
|
+
|
156
|
+
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
157
|
+
#html_show_copyright = True
|
158
|
+
|
159
|
+
# If true, an OpenSearch description file will be output, and all pages will
|
160
|
+
# contain a <link> tag referring to it. The value of this option must be the
|
161
|
+
# base URL from which the finished HTML is served.
|
162
|
+
#html_use_opensearch = ''
|
163
|
+
|
164
|
+
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
165
|
+
#html_file_suffix = None
|
166
|
+
|
167
|
+
# Output file base name for HTML help builder.
|
168
|
+
htmlhelp_basename = 'Kelpdoc'
|
169
|
+
|
170
|
+
|
171
|
+
# -- Options for LaTeX output --------------------------------------------------
|
172
|
+
|
173
|
+
# The paper size ('letter' or 'a4').
|
174
|
+
#latex_paper_size = 'letter'
|
175
|
+
|
176
|
+
# The font size ('10pt', '11pt' or '12pt').
|
177
|
+
#latex_font_size = '10pt'
|
178
|
+
|
179
|
+
# Grouping the document tree into LaTeX files. List of tuples
|
180
|
+
# (source start file, target name, title, author, documentclass [howto/manual]).
|
181
|
+
latex_documents = [
|
182
|
+
('index', 'Kelp.tex', u'Kelp Documentation',
|
183
|
+
u'Eric Pierce', 'manual'),
|
184
|
+
]
|
185
|
+
|
186
|
+
# The name of an image file (relative to this directory) to place at the top of
|
187
|
+
# the title page.
|
188
|
+
#latex_logo = None
|
189
|
+
|
190
|
+
# For "manual" documents, if this is true, then toplevel headings are parts,
|
191
|
+
# not chapters.
|
192
|
+
#latex_use_parts = False
|
193
|
+
|
194
|
+
# If true, show page references after internal links.
|
195
|
+
#latex_show_pagerefs = False
|
196
|
+
|
197
|
+
# If true, show URL addresses after external links.
|
198
|
+
#latex_show_urls = False
|
199
|
+
|
200
|
+
# Additional stuff for the LaTeX preamble.
|
201
|
+
#latex_preamble = ''
|
202
|
+
|
203
|
+
# Documents to append as an appendix to all manuals.
|
204
|
+
#latex_appendices = []
|
205
|
+
|
206
|
+
# If false, no module index is generated.
|
207
|
+
#latex_domain_indices = True
|
208
|
+
|
209
|
+
|
210
|
+
# -- Options for manual page output --------------------------------------------
|
211
|
+
|
212
|
+
# One entry per manual page. List of tuples
|
213
|
+
# (source start file, name, description, authors, manual section).
|
214
|
+
man_pages = [
|
215
|
+
('index', 'kelp', u'Kelp Documentation',
|
216
|
+
[u'Eric Pierce'], 1)
|
217
|
+
]
|