kelp 0.1.1 → 0.1.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (56) hide show
  1. data/.gitignore +2 -0
  2. data/.yardopts +6 -0
  3. data/Gemfile +4 -9
  4. data/Gemfile.lock +8 -0
  5. data/History.md +22 -0
  6. data/README.md +154 -7
  7. data/kelp.gemspec +1 -1
  8. data/lib/kelp.rb +8 -1
  9. data/lib/kelp/attribute.rb +31 -0
  10. data/lib/kelp/checkbox.rb +31 -0
  11. data/lib/kelp/dropdown.rb +109 -0
  12. data/lib/kelp/field.rb +159 -0
  13. data/lib/kelp/helper.rb +14 -0
  14. data/lib/kelp/navigation.rb +63 -0
  15. data/lib/kelp/scoping.rb +45 -0
  16. data/lib/kelp/visibility.rb +176 -0
  17. data/lib/kelp/xpath.rb +14 -0
  18. data/spec/attribute_spec.rb +56 -0
  19. data/spec/checkbox_spec.rb +69 -0
  20. data/spec/dropdown_spec.rb +176 -0
  21. data/spec/field_spec.rb +290 -0
  22. data/spec/navigation_spec.rb +89 -0
  23. data/spec/scoping_spec.rb +0 -0
  24. data/spec/{capybara/spec_helper.rb → spec_helper.rb} +9 -5
  25. data/spec/test_app/views/form.erb +24 -0
  26. data/spec/visibility_spec.rb +315 -0
  27. data/spec/xpath_spec.rb +0 -0
  28. data/step_definitions/capybara_steps.rb +132 -0
  29. metadata +25 -32
  30. data/docs/Makefile +0 -130
  31. data/docs/_static/custom.css +0 -9
  32. data/docs/conf.py +0 -217
  33. data/docs/development.rst +0 -27
  34. data/docs/future.rst +0 -9
  35. data/docs/index.rst +0 -33
  36. data/docs/make.bat +0 -155
  37. data/docs/testing.rst +0 -15
  38. data/docs/usage.rst +0 -85
  39. data/lib/kelp/capybara.rb +0 -2
  40. data/lib/kelp/capybara/capybara_steps.rb +0 -225
  41. data/lib/kelp/capybara/form_helper.rb +0 -131
  42. data/lib/kelp/capybara/web_helper.rb +0 -148
  43. data/spec/capybara/click_link_in_row_spec.rb +0 -24
  44. data/spec/capybara/dropdown_spec.rb +0 -112
  45. data/spec/capybara/field_should_be_empty_spec.rb +0 -44
  46. data/spec/capybara/field_should_contain_spec.rb +0 -143
  47. data/spec/capybara/fill_in_fields_spec.rb +0 -67
  48. data/spec/capybara/follow_spec.rb +0 -35
  49. data/spec/capybara/page_should_have_spec.rb +0 -48
  50. data/spec/capybara/page_should_not_have_spec.rb +0 -53
  51. data/spec/capybara/press_spec.rb +0 -33
  52. data/spec/capybara/should_be_disabled_spec.rb +0 -28
  53. data/spec/capybara/should_be_enabled_spec.rb +0 -29
  54. data/spec/capybara/should_not_see_spec.rb +0 -97
  55. data/spec/capybara/should_see_in_same_row_spec.rb +0 -41
  56. data/spec/capybara/should_see_spec.rb +0 -80
File without changes
@@ -0,0 +1,132 @@
1
+
2
+ require 'uri'
3
+ require 'cgi'
4
+ require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
5
+ #require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "selectors"))
6
+
7
+ # Single-line step scoper
8
+ When /^(.*) within ([^:]+)$/ do |step, parent|
9
+ scope_within(parent) { When step }
10
+ end
11
+
12
+ # Multi-line step scoper
13
+ When /^(.*) within ([^:]+):$/ do |step, parent, table_or_string|
14
+ scope_within(parent) { When "#{step}:", table_or_string }
15
+ end
16
+
17
+ Given /^(?:|I )am on (.+)$/ do |page_name|
18
+ visit path_to(page_name)
19
+ end
20
+
21
+ When /^(?:|I )go to (.+)$/ do |page_name|
22
+ visit path_to(page_name)
23
+ end
24
+
25
+ When /^(?:|I )press "([^"]*)"$/ do |button|
26
+ click_button button
27
+ end
28
+
29
+ When /^(?:|I )follow "([^"]*)"$/ do |link|
30
+ click_link link
31
+ end
32
+
33
+ When /^(?:|I )fill in "([^"]*)" with "([^"]*)"$/ do |field, value|
34
+ fill_in field, :with => value
35
+ end
36
+
37
+ When /^(?:|I )fill in "([^"]*)" for "([^"]*)"$/ do |value, field|
38
+ fill_in field, :with => value
39
+ end
40
+
41
+ # Use this to fill in an entire form with data from a table. Example:
42
+ #
43
+ # When I fill in the following:
44
+ # | Account Number | 5002 |
45
+ # | Expiry date | 2009-11-01 |
46
+ # | Note | Nice guy |
47
+ # | Wants Email? | |
48
+ #
49
+ # TODO: Add support for checkbox, select og option
50
+ # based on naming conventions.
51
+ #
52
+ When /^(?:|I )fill in the following:$/ do |fields|
53
+ fill_in_fields fields.rows_hash
54
+ end
55
+
56
+ When /^(?:|I )select "([^"]*)" from "([^"]*)"$/ do |value, field|
57
+ select value, :from => field
58
+ end
59
+
60
+ When /^(?:|I )check "([^"]*)"$/ do |field|
61
+ check field
62
+ end
63
+
64
+ When /^(?:|I )uncheck "([^"]*)"$/ do |field|
65
+ uncheck field
66
+ end
67
+
68
+ When /^(?:|I )choose "([^"]*)"$/ do |field|
69
+ choose field
70
+ end
71
+
72
+ When /^(?:|I )attach the file "([^"]*)" to "([^"]*)"$/ do |path, field|
73
+ attach_file field, File.expand_path(path)
74
+ end
75
+
76
+ Then /^(?:|I )should see "([^"]*)"$/ do |text|
77
+ should_see text
78
+ end
79
+
80
+ Then /^(?:|I )should see \/([^\/]*)\/$/ do |regexp|
81
+ should_see Regexp.new(regexp)
82
+ end
83
+
84
+ Then /^(?:|I )should not see "([^"]*)"$/ do |text|
85
+ should_not_see text
86
+ end
87
+
88
+ Then /^(?:|I )should not see \/([^\/]*)\/$/ do |regexp|
89
+ should_not_see Regexp.new(regexp)
90
+ end
91
+
92
+ Then /^the "([^"]*)" field(?: within (.*))? should contain "([^"]*)"$/ do |field, parent, value|
93
+ field_should_contain field, value, :within => parent
94
+ end
95
+
96
+ Then /^the "([^"]*)" field(?: within (.*))? should not contain "([^"]*)"$/ do |field, parent, value|
97
+ field_should_not_contain field, value, :within => parent
98
+ end
99
+
100
+ Then /^the "([^"]*)" checkbox(?: within (.*))? should be checked$/ do |label, parent|
101
+ checkbox_should_be_checked label, :within => parent
102
+ end
103
+
104
+ Then /^the "([^"]*)" checkbox(?: within (.*))? should not be checked$/ do |label, parent|
105
+ checkbox_should_not_be_checked label, :within => parent
106
+ end
107
+
108
+ Then /^(?:|I )should be on (.+)$/ do |page_name|
109
+ current_path = URI.parse(current_url).path
110
+ if current_path.respond_to? :should
111
+ current_path.should == path_to(page_name)
112
+ else
113
+ assert_equal path_to(page_name), current_path
114
+ end
115
+ end
116
+
117
+ Then /^(?:|I )should have the following query string:$/ do |expected_pairs|
118
+ query = URI.parse(current_url).query
119
+ actual_params = query ? CGI.parse(query) : {}
120
+ expected_params = {}
121
+ expected_pairs.rows_hash.each_pair{|k,v| expected_params[k] = v.split(',')}
122
+
123
+ if actual_params.respond_to? :should
124
+ actual_params.should == expected_params
125
+ else
126
+ assert_equal expected_params, actual_params
127
+ end
128
+ end
129
+
130
+ Then /^show me the page$/ do
131
+ save_and_open_page
132
+ end
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: kelp
3
3
  version: !ruby/object:Gem::Version
4
- hash: 25
4
+ hash: 31
5
5
  prerelease: false
6
6
  segments:
7
7
  - 0
8
8
  - 1
9
- - 1
10
- version: 0.1.1
9
+ - 2
10
+ version: 0.1.2
11
11
  platform: ruby
12
12
  authors:
13
13
  - Eric Pierce
@@ -15,7 +15,7 @@ autorequire:
15
15
  bindir: bin
16
16
  cert_chain: []
17
17
 
18
- date: 2010-12-13 00:00:00 -07:00
18
+ date: 2011-01-11 00:00:00 -07:00
19
19
  default_executable:
20
20
  dependencies:
21
21
  - !ruby/object:Gem::Dependency
@@ -102,41 +102,31 @@ extra_rdoc_files: []
102
102
 
103
103
  files:
104
104
  - .gitignore
105
+ - .yardopts
105
106
  - Gemfile
106
107
  - Gemfile.lock
108
+ - History.md
107
109
  - MIT-LICENSE
108
110
  - README.md
109
111
  - Rakefile
110
- - docs/Makefile
111
- - docs/_static/custom.css
112
- - docs/conf.py
113
- - docs/development.rst
114
- - docs/future.rst
115
- - docs/index.rst
116
- - docs/make.bat
117
- - docs/testing.rst
118
- - docs/usage.rst
119
112
  - kelp.gemspec
120
113
  - lib/kelp.rb
121
- - lib/kelp/capybara.rb
122
- - lib/kelp/capybara/capybara_steps.rb
123
- - lib/kelp/capybara/form_helper.rb
124
- - lib/kelp/capybara/web_helper.rb
125
- - spec/capybara/click_link_in_row_spec.rb
126
- - spec/capybara/dropdown_spec.rb
127
- - spec/capybara/field_should_be_empty_spec.rb
128
- - spec/capybara/field_should_contain_spec.rb
129
- - spec/capybara/fill_in_fields_spec.rb
130
- - spec/capybara/follow_spec.rb
131
- - spec/capybara/page_should_have_spec.rb
132
- - spec/capybara/page_should_not_have_spec.rb
133
- - spec/capybara/press_spec.rb
134
- - spec/capybara/should_be_disabled_spec.rb
135
- - spec/capybara/should_be_enabled_spec.rb
136
- - spec/capybara/should_not_see_spec.rb
137
- - spec/capybara/should_see_in_same_row_spec.rb
138
- - spec/capybara/should_see_spec.rb
139
- - spec/capybara/spec_helper.rb
114
+ - lib/kelp/attribute.rb
115
+ - lib/kelp/checkbox.rb
116
+ - lib/kelp/dropdown.rb
117
+ - lib/kelp/field.rb
118
+ - lib/kelp/helper.rb
119
+ - lib/kelp/navigation.rb
120
+ - lib/kelp/scoping.rb
121
+ - lib/kelp/visibility.rb
122
+ - lib/kelp/xpath.rb
123
+ - spec/attribute_spec.rb
124
+ - spec/checkbox_spec.rb
125
+ - spec/dropdown_spec.rb
126
+ - spec/field_spec.rb
127
+ - spec/navigation_spec.rb
128
+ - spec/scoping_spec.rb
129
+ - spec/spec_helper.rb
140
130
  - spec/test_app/test_app.rb
141
131
  - spec/test_app/views/about.erb
142
132
  - spec/test_app/views/edit1.erb
@@ -145,6 +135,9 @@ files:
145
135
  - spec/test_app/views/form.erb
146
136
  - spec/test_app/views/home.erb
147
137
  - spec/test_app/views/thanks.erb
138
+ - spec/visibility_spec.rb
139
+ - spec/xpath_spec.rb
140
+ - step_definitions/capybara_steps.rb
148
141
  has_rdoc: true
149
142
  homepage: http://github.com/wapcaplet/kelp
150
143
  licenses: []
data/docs/Makefile DELETED
@@ -1,130 +0,0 @@
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."
@@ -1,9 +0,0 @@
1
- @import url("sphinxdoc.css");
2
-
3
- div.body a {
4
- text-decoration: none;
5
- }
6
- div.body a:hover, div.body a:focus {
7
- text-decoration: underline;
8
- }
9
-
data/docs/conf.py DELETED
@@ -1,217 +0,0 @@
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
- ]