roroacms 0.0.7.1 → 0.0.7.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/app/assets/images/roroacms/admin/favicon.ico +0 -0
- data/app/assets/javascripts/roroacms/admin/site.js +7 -0
- data/app/assets/stylesheets/roroacms/admin/main.css.scss +14 -0
- data/app/helpers/roroacms/media_helper.rb +1 -0
- data/app/helpers/roroacms/menu_helper.rb +26 -15
- data/app/views/layouts/roroacms/admin.html.erb +2 -2
- data/app/views/roroacms/admin/settings/index.html.erb +2 -2
- data/docs/Makefile +177 -0
- data/docs/_build/doctrees/environment.pickle +0 -0
- data/docs/_build/doctrees/index.doctree +0 -0
- data/docs/_build/html/.buildinfo +4 -0
- data/docs/_build/html/_sources/index.txt +41 -0
- data/docs/_build/html/_static/ajax-loader.gif +0 -0
- data/docs/_build/html/_static/basic.css +537 -0
- data/docs/_build/html/_static/comment-bright.png +0 -0
- data/docs/_build/html/_static/comment-close.png +0 -0
- data/docs/_build/html/_static/comment.png +0 -0
- data/docs/_build/html/_static/default.css +256 -0
- data/docs/_build/html/_static/doctools.js +238 -0
- data/docs/_build/html/_static/down-pressed.png +0 -0
- data/docs/_build/html/_static/down.png +0 -0
- data/docs/_build/html/_static/file.png +0 -0
- data/docs/_build/html/_static/jquery.js +2 -0
- data/docs/_build/html/_static/minus.png +0 -0
- data/docs/_build/html/_static/plus.png +0 -0
- data/docs/_build/html/_static/pygments.css +62 -0
- data/docs/_build/html/_static/searchtools.js +622 -0
- data/docs/_build/html/_static/sidebar.js +159 -0
- data/docs/_build/html/_static/underscore.js +31 -0
- data/docs/_build/html/_static/up-pressed.png +0 -0
- data/docs/_build/html/_static/up.png +0 -0
- data/docs/_build/html/_static/websupport.js +808 -0
- data/docs/_build/html/genindex.html +92 -0
- data/docs/_build/html/index.html +138 -0
- data/docs/_build/html/objects.inv +0 -0
- data/docs/_build/html/search.html +99 -0
- data/docs/_build/html/searchindex.js +1 -0
- data/docs/_images/logo.png +0 -0
- data/docs/_themes/roroa_rtd_theme/__init__.py +17 -0
- data/docs/_themes/roroa_rtd_theme/breadcrumbs.html +19 -0
- data/docs/_themes/roroa_rtd_theme/footer.html +31 -0
- data/docs/_themes/roroa_rtd_theme/layout.html +161 -0
- data/docs/_themes/roroa_rtd_theme/layout_old.html +205 -0
- data/docs/_themes/roroa_rtd_theme/search.html +50 -0
- data/docs/_themes/roroa_rtd_theme/searchbox.html +7 -0
- data/docs/_themes/roroa_rtd_theme/static/css/badge_only.css +1 -0
- data/docs/_themes/roroa_rtd_theme/static/css/sylius.css +57 -0
- data/docs/_themes/roroa_rtd_theme/static/css/theme.css +3224 -0
- data/docs/_themes/roroa_rtd_theme/static/fonts/FontAwesome.otf +0 -0
- data/docs/_themes/roroa_rtd_theme/static/fonts/fontawesome-webfont.eot +0 -0
- data/docs/_themes/roroa_rtd_theme/static/fonts/fontawesome-webfont.svg +414 -0
- data/docs/_themes/roroa_rtd_theme/static/fonts/fontawesome-webfont.ttf +0 -0
- data/docs/_themes/roroa_rtd_theme/static/fonts/fontawesome-webfont.woff +0 -0
- data/docs/_themes/roroa_rtd_theme/static/img/logo.png +0 -0
- data/docs/_themes/roroa_rtd_theme/static/js/theme.js +47 -0
- data/docs/_themes/roroa_rtd_theme/theme.conf +8 -0
- data/docs/_themes/roroa_rtd_theme/versions.html +37 -0
- data/docs/conf.py +259 -0
- data/docs/index.rst +41 -0
- data/docs/make.bat +242 -0
- data/lib/roroacms/engine.rb +1 -1
- data/lib/roroacms/version.rb +1 -1
- metadata +318 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4b2053d6b26e34dfc661d3d9d4cb42264cfd1260
|
4
|
+
data.tar.gz: 3fa9b61a9ffc20a71b04d0057b3250341d0ff9bc
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 34bef1d27a362f0d2534a7b06042afb013f03ca0fbd374466b7af21eecf57fd1eba3d68cace8bf31cd0eac1bef28af6d28f91866d7b7a786c3af33709e21e9e3
|
7
|
+
data.tar.gz: 05d1cc444c50d560baa87d9eed071dc3649bd70e7122dbd6002be1a0a52aa38644a1f9e423b33b1813117506ff4d64cfd9cc548bfcd36eb6d30a28d9c13e4e19
|
Binary file
|
@@ -22,10 +22,17 @@ app = (function() {
|
|
22
22
|
};
|
23
23
|
toggleMenuLeft = function() {
|
24
24
|
$("#toggle-left").bind("click", function(e) {
|
25
|
+
|
26
|
+
if($(".sidebar").hasClass('manual') && $(window).width() < 767){
|
27
|
+
$(".sidebar").removeClass('manual').removeClass('sidebar-toggle');
|
28
|
+
$(".main-content-wrapper").removeClass('manual').removeClass("main-content-toggle-left");
|
29
|
+
}
|
30
|
+
|
25
31
|
if (!$(".sidebar-right").hasClass(".sidebar-toggle-right")) {
|
26
32
|
$(".sidebar-right").removeClass("sidebar-toggle-right");
|
27
33
|
$(".main-content-wrapper").removeClass("main-content-toggle-right");
|
28
34
|
}
|
35
|
+
|
29
36
|
$(".sidebar").toggleClass("sidebar-toggle");
|
30
37
|
$(".main-content-wrapper").toggleClass("main-content-toggle-left");
|
31
38
|
e.stopPropagation();
|
@@ -3535,6 +3535,11 @@ small.mic-info {
|
|
3535
3535
|
padding:10px 0px;
|
3536
3536
|
}
|
3537
3537
|
|
3538
|
+
.features .editor .editorwrap {
|
3539
|
+
width:100%;
|
3540
|
+
max-width: 100%;
|
3541
|
+
}
|
3542
|
+
|
3538
3543
|
|
3539
3544
|
@media only screen and (max-width: 767px) and (min-width: 480px) {
|
3540
3545
|
#main-content .h1 {
|
@@ -3634,6 +3639,15 @@ small.mic-info {
|
|
3634
3639
|
.view-all-revisions {
|
3635
3640
|
width: 100%;
|
3636
3641
|
}
|
3642
|
+
|
3643
|
+
.main-content-toggle-left.manual {
|
3644
|
+
margin-left:0px;
|
3645
|
+
}
|
3646
|
+
|
3647
|
+
.sidebar-toggle.manual {
|
3648
|
+
margin-left: -240px;
|
3649
|
+
width: 240px;
|
3650
|
+
}
|
3637
3651
|
}
|
3638
3652
|
@media only screen and (max-width: 660px) {
|
3639
3653
|
#header {
|
@@ -21,6 +21,7 @@ module Roroacms
|
|
21
21
|
|
22
22
|
|
23
23
|
def upload_images(file, type, initial_folder_path = 'users')
|
24
|
+
|
24
25
|
path = "#{BUCKET}/" + Setting.get("aws_folder") + "/" + initial_folder_path.to_s + "/" + type.to_s + "/" + file.original_filename
|
25
26
|
begin
|
26
27
|
obj = S3.buckets[BUCKET].objects["#{path}"].write(:file => file, :acl => :public_read)
|
@@ -129,41 +129,52 @@ module Roroacms
|
|
129
129
|
|
130
130
|
# start the string by defining the target
|
131
131
|
atts = get_target(existingData['target'])
|
132
|
+
p = Post.find_by_id(existingData['linkto'])
|
133
|
+
blog = false
|
132
134
|
|
133
|
-
if menuOption.data_type == 'page'
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
|
142
|
-
url = site_url(article_url + p.structured_url)
|
143
|
-
atts += " href='#{url}' class='menu_link'"
|
144
|
-
end
|
135
|
+
if menuOption.data_type == 'page' && !p.blank?
|
136
|
+
|
137
|
+
url = p.id == home_id.to_i ? site_url() : site_url(p.structured_url)
|
138
|
+
atts += " href='#{url}' class='menu_link'"
|
139
|
+
|
140
|
+
elsif menuOption.data_type == 'article' && !p.blank?
|
141
|
+
|
142
|
+
url = site_url(article_url + p.structured_url)
|
143
|
+
atts += " href='#{url}' class='menu_link'"
|
145
144
|
|
146
145
|
elsif menuOption.data_type == 'category'
|
146
|
+
|
147
147
|
t = Term.find(existingData['linkto'])
|
148
148
|
url = site_url(article_url + '/' + category_url + t.structured_url)
|
149
149
|
atts += " href='#{url}' class='menu_link'"
|
150
150
|
|
151
151
|
elsif menuOption.data_type == 'tag'
|
152
|
+
|
152
153
|
t = Term.find(existingData['linkto'])
|
153
154
|
url = site_url(article_url + '/' + tag_url + t.structured_url)
|
154
155
|
atts += " href='#{url}' class='menu_link'"
|
155
156
|
|
156
|
-
elsif menuOption.data_type == article_url && menuOption.option_id == 0
|
157
|
+
elsif menuOption.data_type == article_url && menuOption.option_id == 0
|
158
|
+
|
157
159
|
url = site_url(article_url)
|
158
|
-
atts += " href='#{url}'"
|
160
|
+
atts += " href='#{url}' class='menu_link'"
|
161
|
+
blog = true
|
159
162
|
|
160
163
|
elsif menuOption.data_type == 'custom'
|
164
|
+
|
161
165
|
url = existingData['customlink']
|
162
166
|
atts += " href='#{url}' class='menu_link'"
|
167
|
+
|
163
168
|
end
|
164
169
|
|
165
170
|
atts = (atts[0..-2] + " #{existingData['class']}'") if !existingData['class'].blank?
|
166
|
-
|
171
|
+
|
172
|
+
if blog && request.original_url.include?(url)
|
173
|
+
atts = (atts[0..-2] + " active'")
|
174
|
+
else
|
175
|
+
atts = (atts[0..-2] + " active'") if url == request.original_url
|
176
|
+
end
|
177
|
+
|
167
178
|
|
168
179
|
atts
|
169
180
|
|
@@ -47,7 +47,7 @@
|
|
47
47
|
</header>
|
48
48
|
<% end %>
|
49
49
|
<!--sidebar left start-->
|
50
|
-
<aside class="sidebar <%= !cookies[:header_menu_contracted].blank? ? 'sidebar-toggle' : '' %>">
|
50
|
+
<aside class="sidebar <%= !cookies[:header_menu_contracted].blank? ? 'sidebar-toggle manual' : '' %>">
|
51
51
|
<div id="leftside-navigation" class="nano">
|
52
52
|
<ul class="nano-content">
|
53
53
|
<li class="<%= cp(roroacms.admin_path) %>">
|
@@ -148,7 +148,7 @@
|
|
148
148
|
</aside>
|
149
149
|
|
150
150
|
|
151
|
-
<section class="main-content-wrapper <%= !cookies[:header_menu_contracted].blank? ? 'main-content-toggle-left' : '' %>">
|
151
|
+
<section class="main-content-wrapper <%= !cookies[:header_menu_contracted].blank? ? 'main-content-toggle-left manual' : '' %>">
|
152
152
|
<section id="main-content">
|
153
153
|
<%= theme_exists %>
|
154
154
|
<% if !current_page?(roroacms.admin_path) %>
|
@@ -20,7 +20,7 @@
|
|
20
20
|
<i class="fa fa-envelope-o"></i>
|
21
21
|
</a>
|
22
22
|
</li>
|
23
|
-
<% if
|
23
|
+
<% if Roroacms::Setting.get('demonstration_mode') != 'Y' %>
|
24
24
|
<li class="tooltipState" data-toggle="tooltip" data-placement="right" data-title="<%= t("views.admin.settings.tabs.aws") %>">
|
25
25
|
<a href="#amazon" data-toggle="tab">
|
26
26
|
<i class="fa fa-cloud-upload"></i>
|
@@ -211,7 +211,7 @@
|
|
211
211
|
|
212
212
|
|
213
213
|
</div>
|
214
|
-
<% if
|
214
|
+
<% if Roroacms::Setting.get('demonstration_mode') != 'Y' %>
|
215
215
|
<div class="tab-pane" id="amazon">
|
216
216
|
<div class="form-group">
|
217
217
|
<%= label_tag(:aws_access_key_id, t("views.admin.settings.tab_content.aws_access_key_id "), class: "col-sm-3 control-label") %>
|
data/docs/Makefile
ADDED
@@ -0,0 +1,177 @@
|
|
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
|
+
# User-friendly check for sphinx-build
|
11
|
+
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
|
12
|
+
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
|
13
|
+
endif
|
14
|
+
|
15
|
+
# Internal variables.
|
16
|
+
PAPEROPT_a4 = -D latex_paper_size=a4
|
17
|
+
PAPEROPT_letter = -D latex_paper_size=letter
|
18
|
+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
19
|
+
# the i18n builder cannot share the environment and doctrees with the others
|
20
|
+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
21
|
+
|
22
|
+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
|
23
|
+
|
24
|
+
help:
|
25
|
+
@echo "Please use \`make <target>' where <target> is one of"
|
26
|
+
@echo " html to make standalone HTML files"
|
27
|
+
@echo " dirhtml to make HTML files named index.html in directories"
|
28
|
+
@echo " singlehtml to make a single large HTML file"
|
29
|
+
@echo " pickle to make pickle files"
|
30
|
+
@echo " json to make JSON files"
|
31
|
+
@echo " htmlhelp to make HTML files and a HTML help project"
|
32
|
+
@echo " qthelp to make HTML files and a qthelp project"
|
33
|
+
@echo " devhelp to make HTML files and a Devhelp project"
|
34
|
+
@echo " epub to make an epub"
|
35
|
+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
36
|
+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
37
|
+
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
38
|
+
@echo " text to make text files"
|
39
|
+
@echo " man to make manual pages"
|
40
|
+
@echo " texinfo to make Texinfo files"
|
41
|
+
@echo " info to make Texinfo files and run them through makeinfo"
|
42
|
+
@echo " gettext to make PO message catalogs"
|
43
|
+
@echo " changes to make an overview of all changed/added/deprecated items"
|
44
|
+
@echo " xml to make Docutils-native XML files"
|
45
|
+
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
46
|
+
@echo " linkcheck to check all external links for integrity"
|
47
|
+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
48
|
+
|
49
|
+
clean:
|
50
|
+
rm -rf $(BUILDDIR)/*
|
51
|
+
|
52
|
+
html:
|
53
|
+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
54
|
+
@echo
|
55
|
+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
56
|
+
|
57
|
+
dirhtml:
|
58
|
+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
59
|
+
@echo
|
60
|
+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
61
|
+
|
62
|
+
singlehtml:
|
63
|
+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
64
|
+
@echo
|
65
|
+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
66
|
+
|
67
|
+
pickle:
|
68
|
+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
69
|
+
@echo
|
70
|
+
@echo "Build finished; now you can process the pickle files."
|
71
|
+
|
72
|
+
json:
|
73
|
+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
74
|
+
@echo
|
75
|
+
@echo "Build finished; now you can process the JSON files."
|
76
|
+
|
77
|
+
htmlhelp:
|
78
|
+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
79
|
+
@echo
|
80
|
+
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
81
|
+
".hhp project file in $(BUILDDIR)/htmlhelp."
|
82
|
+
|
83
|
+
qthelp:
|
84
|
+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
85
|
+
@echo
|
86
|
+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
87
|
+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
88
|
+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/RoroaCMS.qhcp"
|
89
|
+
@echo "To view the help file:"
|
90
|
+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/RoroaCMS.qhc"
|
91
|
+
|
92
|
+
devhelp:
|
93
|
+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
94
|
+
@echo
|
95
|
+
@echo "Build finished."
|
96
|
+
@echo "To view the help file:"
|
97
|
+
@echo "# mkdir -p $$HOME/.local/share/devhelp/RoroaCMS"
|
98
|
+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/RoroaCMS"
|
99
|
+
@echo "# devhelp"
|
100
|
+
|
101
|
+
epub:
|
102
|
+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
103
|
+
@echo
|
104
|
+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
105
|
+
|
106
|
+
latex:
|
107
|
+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
108
|
+
@echo
|
109
|
+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
110
|
+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
111
|
+
"(use \`make latexpdf' here to do that automatically)."
|
112
|
+
|
113
|
+
latexpdf:
|
114
|
+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
115
|
+
@echo "Running LaTeX files through pdflatex..."
|
116
|
+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
117
|
+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
118
|
+
|
119
|
+
latexpdfja:
|
120
|
+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
121
|
+
@echo "Running LaTeX files through platex and dvipdfmx..."
|
122
|
+
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
123
|
+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
124
|
+
|
125
|
+
text:
|
126
|
+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
127
|
+
@echo
|
128
|
+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
129
|
+
|
130
|
+
man:
|
131
|
+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
132
|
+
@echo
|
133
|
+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
134
|
+
|
135
|
+
texinfo:
|
136
|
+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
137
|
+
@echo
|
138
|
+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
139
|
+
@echo "Run \`make' in that directory to run these through makeinfo" \
|
140
|
+
"(use \`make info' here to do that automatically)."
|
141
|
+
|
142
|
+
info:
|
143
|
+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
144
|
+
@echo "Running Texinfo files through makeinfo..."
|
145
|
+
make -C $(BUILDDIR)/texinfo info
|
146
|
+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
147
|
+
|
148
|
+
gettext:
|
149
|
+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
150
|
+
@echo
|
151
|
+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
152
|
+
|
153
|
+
changes:
|
154
|
+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
155
|
+
@echo
|
156
|
+
@echo "The overview file is in $(BUILDDIR)/changes."
|
157
|
+
|
158
|
+
linkcheck:
|
159
|
+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
160
|
+
@echo
|
161
|
+
@echo "Link check complete; look for any errors in the above output " \
|
162
|
+
"or in $(BUILDDIR)/linkcheck/output.txt."
|
163
|
+
|
164
|
+
doctest:
|
165
|
+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
166
|
+
@echo "Testing of doctests in the sources finished, look at the " \
|
167
|
+
"results in $(BUILDDIR)/doctest/output.txt."
|
168
|
+
|
169
|
+
xml:
|
170
|
+
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
171
|
+
@echo
|
172
|
+
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
173
|
+
|
174
|
+
pseudoxml:
|
175
|
+
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
176
|
+
@echo
|
177
|
+
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
Binary file
|
Binary file
|
@@ -0,0 +1,41 @@
|
|
1
|
+
$project
|
2
|
+
========
|
3
|
+
|
4
|
+
$project will solve your problem of where to start with documentation,
|
5
|
+
by providing a basic explanation of how to do it easily.
|
6
|
+
|
7
|
+
Look how easy it is to use:
|
8
|
+
|
9
|
+
import project
|
10
|
+
# Get your stuff done
|
11
|
+
project.do_stuff()
|
12
|
+
|
13
|
+
Features
|
14
|
+
--------
|
15
|
+
|
16
|
+
- Be awesome
|
17
|
+
- Make things faster
|
18
|
+
|
19
|
+
Installation
|
20
|
+
------------
|
21
|
+
|
22
|
+
Install $project by running:
|
23
|
+
|
24
|
+
install project
|
25
|
+
|
26
|
+
Contribute
|
27
|
+
----------
|
28
|
+
|
29
|
+
- Issue Tracker: github.com/$project/$project/issues
|
30
|
+
- Source Code: github.com/$project/$project
|
31
|
+
|
32
|
+
Support
|
33
|
+
-------
|
34
|
+
|
35
|
+
If you are having issues, please let us know.
|
36
|
+
We have a mailing list located at: project@google-groups.com
|
37
|
+
|
38
|
+
License
|
39
|
+
-------
|
40
|
+
|
41
|
+
The project is licensed under the BSD license.
|
Binary file
|
@@ -0,0 +1,537 @@
|
|
1
|
+
/*
|
2
|
+
* basic.css
|
3
|
+
* ~~~~~~~~~
|
4
|
+
*
|
5
|
+
* Sphinx stylesheet -- basic theme.
|
6
|
+
*
|
7
|
+
* :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
|
8
|
+
* :license: BSD, see LICENSE for details.
|
9
|
+
*
|
10
|
+
*/
|
11
|
+
|
12
|
+
/* -- main layout ----------------------------------------------------------- */
|
13
|
+
|
14
|
+
div.clearer {
|
15
|
+
clear: both;
|
16
|
+
}
|
17
|
+
|
18
|
+
/* -- relbar ---------------------------------------------------------------- */
|
19
|
+
|
20
|
+
div.related {
|
21
|
+
width: 100%;
|
22
|
+
font-size: 90%;
|
23
|
+
}
|
24
|
+
|
25
|
+
div.related h3 {
|
26
|
+
display: none;
|
27
|
+
}
|
28
|
+
|
29
|
+
div.related ul {
|
30
|
+
margin: 0;
|
31
|
+
padding: 0 0 0 10px;
|
32
|
+
list-style: none;
|
33
|
+
}
|
34
|
+
|
35
|
+
div.related li {
|
36
|
+
display: inline;
|
37
|
+
}
|
38
|
+
|
39
|
+
div.related li.right {
|
40
|
+
float: right;
|
41
|
+
margin-right: 5px;
|
42
|
+
}
|
43
|
+
|
44
|
+
/* -- sidebar --------------------------------------------------------------- */
|
45
|
+
|
46
|
+
div.sphinxsidebarwrapper {
|
47
|
+
padding: 10px 5px 0 10px;
|
48
|
+
}
|
49
|
+
|
50
|
+
div.sphinxsidebar {
|
51
|
+
float: left;
|
52
|
+
width: 230px;
|
53
|
+
margin-left: -100%;
|
54
|
+
font-size: 90%;
|
55
|
+
}
|
56
|
+
|
57
|
+
div.sphinxsidebar ul {
|
58
|
+
list-style: none;
|
59
|
+
}
|
60
|
+
|
61
|
+
div.sphinxsidebar ul ul,
|
62
|
+
div.sphinxsidebar ul.want-points {
|
63
|
+
margin-left: 20px;
|
64
|
+
list-style: square;
|
65
|
+
}
|
66
|
+
|
67
|
+
div.sphinxsidebar ul ul {
|
68
|
+
margin-top: 0;
|
69
|
+
margin-bottom: 0;
|
70
|
+
}
|
71
|
+
|
72
|
+
div.sphinxsidebar form {
|
73
|
+
margin-top: 10px;
|
74
|
+
}
|
75
|
+
|
76
|
+
div.sphinxsidebar input {
|
77
|
+
border: 1px solid #98dbcc;
|
78
|
+
font-family: sans-serif;
|
79
|
+
font-size: 1em;
|
80
|
+
}
|
81
|
+
|
82
|
+
div.sphinxsidebar #searchbox input[type="text"] {
|
83
|
+
width: 170px;
|
84
|
+
}
|
85
|
+
|
86
|
+
div.sphinxsidebar #searchbox input[type="submit"] {
|
87
|
+
width: 30px;
|
88
|
+
}
|
89
|
+
|
90
|
+
img {
|
91
|
+
border: 0;
|
92
|
+
max-width: 100%;
|
93
|
+
}
|
94
|
+
|
95
|
+
/* -- search page ----------------------------------------------------------- */
|
96
|
+
|
97
|
+
ul.search {
|
98
|
+
margin: 10px 0 0 20px;
|
99
|
+
padding: 0;
|
100
|
+
}
|
101
|
+
|
102
|
+
ul.search li {
|
103
|
+
padding: 5px 0 5px 20px;
|
104
|
+
background-image: url(file.png);
|
105
|
+
background-repeat: no-repeat;
|
106
|
+
background-position: 0 7px;
|
107
|
+
}
|
108
|
+
|
109
|
+
ul.search li a {
|
110
|
+
font-weight: bold;
|
111
|
+
}
|
112
|
+
|
113
|
+
ul.search li div.context {
|
114
|
+
color: #888;
|
115
|
+
margin: 2px 0 0 30px;
|
116
|
+
text-align: left;
|
117
|
+
}
|
118
|
+
|
119
|
+
ul.keywordmatches li.goodmatch a {
|
120
|
+
font-weight: bold;
|
121
|
+
}
|
122
|
+
|
123
|
+
/* -- index page ------------------------------------------------------------ */
|
124
|
+
|
125
|
+
table.contentstable {
|
126
|
+
width: 90%;
|
127
|
+
}
|
128
|
+
|
129
|
+
table.contentstable p.biglink {
|
130
|
+
line-height: 150%;
|
131
|
+
}
|
132
|
+
|
133
|
+
a.biglink {
|
134
|
+
font-size: 1.3em;
|
135
|
+
}
|
136
|
+
|
137
|
+
span.linkdescr {
|
138
|
+
font-style: italic;
|
139
|
+
padding-top: 5px;
|
140
|
+
font-size: 90%;
|
141
|
+
}
|
142
|
+
|
143
|
+
/* -- general index --------------------------------------------------------- */
|
144
|
+
|
145
|
+
table.indextable {
|
146
|
+
width: 100%;
|
147
|
+
}
|
148
|
+
|
149
|
+
table.indextable td {
|
150
|
+
text-align: left;
|
151
|
+
vertical-align: top;
|
152
|
+
}
|
153
|
+
|
154
|
+
table.indextable dl, table.indextable dd {
|
155
|
+
margin-top: 0;
|
156
|
+
margin-bottom: 0;
|
157
|
+
}
|
158
|
+
|
159
|
+
table.indextable tr.pcap {
|
160
|
+
height: 10px;
|
161
|
+
}
|
162
|
+
|
163
|
+
table.indextable tr.cap {
|
164
|
+
margin-top: 10px;
|
165
|
+
background-color: #f2f2f2;
|
166
|
+
}
|
167
|
+
|
168
|
+
img.toggler {
|
169
|
+
margin-right: 3px;
|
170
|
+
margin-top: 3px;
|
171
|
+
cursor: pointer;
|
172
|
+
}
|
173
|
+
|
174
|
+
div.modindex-jumpbox {
|
175
|
+
border-top: 1px solid #ddd;
|
176
|
+
border-bottom: 1px solid #ddd;
|
177
|
+
margin: 1em 0 1em 0;
|
178
|
+
padding: 0.4em;
|
179
|
+
}
|
180
|
+
|
181
|
+
div.genindex-jumpbox {
|
182
|
+
border-top: 1px solid #ddd;
|
183
|
+
border-bottom: 1px solid #ddd;
|
184
|
+
margin: 1em 0 1em 0;
|
185
|
+
padding: 0.4em;
|
186
|
+
}
|
187
|
+
|
188
|
+
/* -- general body styles --------------------------------------------------- */
|
189
|
+
|
190
|
+
a.headerlink {
|
191
|
+
visibility: hidden;
|
192
|
+
}
|
193
|
+
|
194
|
+
h1:hover > a.headerlink,
|
195
|
+
h2:hover > a.headerlink,
|
196
|
+
h3:hover > a.headerlink,
|
197
|
+
h4:hover > a.headerlink,
|
198
|
+
h5:hover > a.headerlink,
|
199
|
+
h6:hover > a.headerlink,
|
200
|
+
dt:hover > a.headerlink {
|
201
|
+
visibility: visible;
|
202
|
+
}
|
203
|
+
|
204
|
+
div.body p.caption {
|
205
|
+
text-align: inherit;
|
206
|
+
}
|
207
|
+
|
208
|
+
div.body td {
|
209
|
+
text-align: left;
|
210
|
+
}
|
211
|
+
|
212
|
+
.field-list ul {
|
213
|
+
padding-left: 1em;
|
214
|
+
}
|
215
|
+
|
216
|
+
.first {
|
217
|
+
margin-top: 0 !important;
|
218
|
+
}
|
219
|
+
|
220
|
+
p.rubric {
|
221
|
+
margin-top: 30px;
|
222
|
+
font-weight: bold;
|
223
|
+
}
|
224
|
+
|
225
|
+
img.align-left, .figure.align-left, object.align-left {
|
226
|
+
clear: left;
|
227
|
+
float: left;
|
228
|
+
margin-right: 1em;
|
229
|
+
}
|
230
|
+
|
231
|
+
img.align-right, .figure.align-right, object.align-right {
|
232
|
+
clear: right;
|
233
|
+
float: right;
|
234
|
+
margin-left: 1em;
|
235
|
+
}
|
236
|
+
|
237
|
+
img.align-center, .figure.align-center, object.align-center {
|
238
|
+
display: block;
|
239
|
+
margin-left: auto;
|
240
|
+
margin-right: auto;
|
241
|
+
}
|
242
|
+
|
243
|
+
.align-left {
|
244
|
+
text-align: left;
|
245
|
+
}
|
246
|
+
|
247
|
+
.align-center {
|
248
|
+
text-align: center;
|
249
|
+
}
|
250
|
+
|
251
|
+
.align-right {
|
252
|
+
text-align: right;
|
253
|
+
}
|
254
|
+
|
255
|
+
/* -- sidebars -------------------------------------------------------------- */
|
256
|
+
|
257
|
+
div.sidebar {
|
258
|
+
margin: 0 0 0.5em 1em;
|
259
|
+
border: 1px solid #ddb;
|
260
|
+
padding: 7px 7px 0 7px;
|
261
|
+
background-color: #ffe;
|
262
|
+
width: 40%;
|
263
|
+
float: right;
|
264
|
+
}
|
265
|
+
|
266
|
+
p.sidebar-title {
|
267
|
+
font-weight: bold;
|
268
|
+
}
|
269
|
+
|
270
|
+
/* -- topics ---------------------------------------------------------------- */
|
271
|
+
|
272
|
+
div.topic {
|
273
|
+
border: 1px solid #ccc;
|
274
|
+
padding: 7px 7px 0 7px;
|
275
|
+
margin: 10px 0 10px 0;
|
276
|
+
}
|
277
|
+
|
278
|
+
p.topic-title {
|
279
|
+
font-size: 1.1em;
|
280
|
+
font-weight: bold;
|
281
|
+
margin-top: 10px;
|
282
|
+
}
|
283
|
+
|
284
|
+
/* -- admonitions ----------------------------------------------------------- */
|
285
|
+
|
286
|
+
div.admonition {
|
287
|
+
margin-top: 10px;
|
288
|
+
margin-bottom: 10px;
|
289
|
+
padding: 7px;
|
290
|
+
}
|
291
|
+
|
292
|
+
div.admonition dt {
|
293
|
+
font-weight: bold;
|
294
|
+
}
|
295
|
+
|
296
|
+
div.admonition dl {
|
297
|
+
margin-bottom: 0;
|
298
|
+
}
|
299
|
+
|
300
|
+
p.admonition-title {
|
301
|
+
margin: 0px 10px 5px 0px;
|
302
|
+
font-weight: bold;
|
303
|
+
}
|
304
|
+
|
305
|
+
div.body p.centered {
|
306
|
+
text-align: center;
|
307
|
+
margin-top: 25px;
|
308
|
+
}
|
309
|
+
|
310
|
+
/* -- tables ---------------------------------------------------------------- */
|
311
|
+
|
312
|
+
table.docutils {
|
313
|
+
border: 0;
|
314
|
+
border-collapse: collapse;
|
315
|
+
}
|
316
|
+
|
317
|
+
table.docutils td, table.docutils th {
|
318
|
+
padding: 1px 8px 1px 5px;
|
319
|
+
border-top: 0;
|
320
|
+
border-left: 0;
|
321
|
+
border-right: 0;
|
322
|
+
border-bottom: 1px solid #aaa;
|
323
|
+
}
|
324
|
+
|
325
|
+
table.field-list td, table.field-list th {
|
326
|
+
border: 0 !important;
|
327
|
+
}
|
328
|
+
|
329
|
+
table.footnote td, table.footnote th {
|
330
|
+
border: 0 !important;
|
331
|
+
}
|
332
|
+
|
333
|
+
th {
|
334
|
+
text-align: left;
|
335
|
+
padding-right: 5px;
|
336
|
+
}
|
337
|
+
|
338
|
+
table.citation {
|
339
|
+
border-left: solid 1px gray;
|
340
|
+
margin-left: 1px;
|
341
|
+
}
|
342
|
+
|
343
|
+
table.citation td {
|
344
|
+
border-bottom: none;
|
345
|
+
}
|
346
|
+
|
347
|
+
/* -- other body styles ----------------------------------------------------- */
|
348
|
+
|
349
|
+
ol.arabic {
|
350
|
+
list-style: decimal;
|
351
|
+
}
|
352
|
+
|
353
|
+
ol.loweralpha {
|
354
|
+
list-style: lower-alpha;
|
355
|
+
}
|
356
|
+
|
357
|
+
ol.upperalpha {
|
358
|
+
list-style: upper-alpha;
|
359
|
+
}
|
360
|
+
|
361
|
+
ol.lowerroman {
|
362
|
+
list-style: lower-roman;
|
363
|
+
}
|
364
|
+
|
365
|
+
ol.upperroman {
|
366
|
+
list-style: upper-roman;
|
367
|
+
}
|
368
|
+
|
369
|
+
dl {
|
370
|
+
margin-bottom: 15px;
|
371
|
+
}
|
372
|
+
|
373
|
+
dd p {
|
374
|
+
margin-top: 0px;
|
375
|
+
}
|
376
|
+
|
377
|
+
dd ul, dd table {
|
378
|
+
margin-bottom: 10px;
|
379
|
+
}
|
380
|
+
|
381
|
+
dd {
|
382
|
+
margin-top: 3px;
|
383
|
+
margin-bottom: 10px;
|
384
|
+
margin-left: 30px;
|
385
|
+
}
|
386
|
+
|
387
|
+
dt:target, .highlighted {
|
388
|
+
background-color: #fbe54e;
|
389
|
+
}
|
390
|
+
|
391
|
+
dl.glossary dt {
|
392
|
+
font-weight: bold;
|
393
|
+
font-size: 1.1em;
|
394
|
+
}
|
395
|
+
|
396
|
+
.field-list ul {
|
397
|
+
margin: 0;
|
398
|
+
padding-left: 1em;
|
399
|
+
}
|
400
|
+
|
401
|
+
.field-list p {
|
402
|
+
margin: 0;
|
403
|
+
}
|
404
|
+
|
405
|
+
.optional {
|
406
|
+
font-size: 1.3em;
|
407
|
+
}
|
408
|
+
|
409
|
+
.versionmodified {
|
410
|
+
font-style: italic;
|
411
|
+
}
|
412
|
+
|
413
|
+
.system-message {
|
414
|
+
background-color: #fda;
|
415
|
+
padding: 5px;
|
416
|
+
border: 3px solid red;
|
417
|
+
}
|
418
|
+
|
419
|
+
.footnote:target {
|
420
|
+
background-color: #ffa;
|
421
|
+
}
|
422
|
+
|
423
|
+
.line-block {
|
424
|
+
display: block;
|
425
|
+
margin-top: 1em;
|
426
|
+
margin-bottom: 1em;
|
427
|
+
}
|
428
|
+
|
429
|
+
.line-block .line-block {
|
430
|
+
margin-top: 0;
|
431
|
+
margin-bottom: 0;
|
432
|
+
margin-left: 1.5em;
|
433
|
+
}
|
434
|
+
|
435
|
+
.guilabel, .menuselection {
|
436
|
+
font-family: sans-serif;
|
437
|
+
}
|
438
|
+
|
439
|
+
.accelerator {
|
440
|
+
text-decoration: underline;
|
441
|
+
}
|
442
|
+
|
443
|
+
.classifier {
|
444
|
+
font-style: oblique;
|
445
|
+
}
|
446
|
+
|
447
|
+
abbr, acronym {
|
448
|
+
border-bottom: dotted 1px;
|
449
|
+
cursor: help;
|
450
|
+
}
|
451
|
+
|
452
|
+
/* -- code displays --------------------------------------------------------- */
|
453
|
+
|
454
|
+
pre {
|
455
|
+
overflow: auto;
|
456
|
+
overflow-y: hidden; /* fixes display issues on Chrome browsers */
|
457
|
+
}
|
458
|
+
|
459
|
+
td.linenos pre {
|
460
|
+
padding: 5px 0px;
|
461
|
+
border: 0;
|
462
|
+
background-color: transparent;
|
463
|
+
color: #aaa;
|
464
|
+
}
|
465
|
+
|
466
|
+
table.highlighttable {
|
467
|
+
margin-left: 0.5em;
|
468
|
+
}
|
469
|
+
|
470
|
+
table.highlighttable td {
|
471
|
+
padding: 0 0.5em 0 0.5em;
|
472
|
+
}
|
473
|
+
|
474
|
+
tt.descname {
|
475
|
+
background-color: transparent;
|
476
|
+
font-weight: bold;
|
477
|
+
font-size: 1.2em;
|
478
|
+
}
|
479
|
+
|
480
|
+
tt.descclassname {
|
481
|
+
background-color: transparent;
|
482
|
+
}
|
483
|
+
|
484
|
+
tt.xref, a tt {
|
485
|
+
background-color: transparent;
|
486
|
+
font-weight: bold;
|
487
|
+
}
|
488
|
+
|
489
|
+
h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
|
490
|
+
background-color: transparent;
|
491
|
+
}
|
492
|
+
|
493
|
+
.viewcode-link {
|
494
|
+
float: right;
|
495
|
+
}
|
496
|
+
|
497
|
+
.viewcode-back {
|
498
|
+
float: right;
|
499
|
+
font-family: sans-serif;
|
500
|
+
}
|
501
|
+
|
502
|
+
div.viewcode-block:target {
|
503
|
+
margin: -1px -10px;
|
504
|
+
padding: 0 10px;
|
505
|
+
}
|
506
|
+
|
507
|
+
/* -- math display ---------------------------------------------------------- */
|
508
|
+
|
509
|
+
img.math {
|
510
|
+
vertical-align: middle;
|
511
|
+
}
|
512
|
+
|
513
|
+
div.body div.math p {
|
514
|
+
text-align: center;
|
515
|
+
}
|
516
|
+
|
517
|
+
span.eqno {
|
518
|
+
float: right;
|
519
|
+
}
|
520
|
+
|
521
|
+
/* -- printout stylesheet --------------------------------------------------- */
|
522
|
+
|
523
|
+
@media print {
|
524
|
+
div.document,
|
525
|
+
div.documentwrapper,
|
526
|
+
div.bodywrapper {
|
527
|
+
margin: 0 !important;
|
528
|
+
width: 100%;
|
529
|
+
}
|
530
|
+
|
531
|
+
div.sphinxsidebar,
|
532
|
+
div.related,
|
533
|
+
div.footer,
|
534
|
+
#top-link {
|
535
|
+
display: none;
|
536
|
+
}
|
537
|
+
}
|