Skip to content

Commit 3571a3d

Browse files
xmo-odooxmo-odoo
committed
Merge pull request odoo-dev#43 from xmo-odoo/website-tutorial
First howto: tutorial to basic website features (dev-wise)
2 parents 5313714 + cab2393 commit 3571a3d

File tree

112 files changed

+21392
-122
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

112 files changed

+21392
-122
lines changed

‎doc/Makefile

+154
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS = -q
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+
# the i18n builder cannot share the environment and doctrees with the others
15+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
16+
17+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
18+
19+
help:
20+
@echo "Please use \`make <target>' where <target> is one of"
21+
@echo " html to make standalone HTML files"
22+
@echo " dirhtml to make HTML files named index.html in directories"
23+
@echo " singlehtml to make a single large HTML file"
24+
@echo " pickle to make pickle files"
25+
@echo " json to make JSON files"
26+
@echo " htmlhelp to make HTML files and a HTML help project"
27+
@echo " qthelp to make HTML files and a qthelp project"
28+
@echo " devhelp to make HTML files and a Devhelp project"
29+
@echo " epub to make an epub"
30+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
31+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
32+
@echo " text to make text files"
33+
@echo " man to make manual pages"
34+
@echo " texinfo to make Texinfo files"
35+
@echo " info to make Texinfo files and run them through makeinfo"
36+
@echo " gettext to make PO message catalogs"
37+
@echo " changes to make an overview of all changed/added/deprecated items"
38+
@echo " linkcheck to check all external links for integrity"
39+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
40+
41+
clean:
42+
-rm -rf $(BUILDDIR)/*
43+
44+
html:
45+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
46+
@echo
47+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
48+
49+
dirhtml:
50+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
51+
sed -i '/-99999/d' _build/dirhtml/_static/flasky.css
52+
@echo
53+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
54+
55+
singlehtml:
56+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
57+
@echo
58+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
59+
60+
pickle:
61+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
62+
@echo
63+
@echo "Build finished; now you can process the pickle files."
64+
65+
json:
66+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
67+
@echo
68+
@echo "Build finished; now you can process the JSON files."
69+
70+
htmlhelp:
71+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
72+
@echo
73+
@echo "Build finished; now you can run HTML Help Workshop with the" \
74+
".hhp project file in $(BUILDDIR)/htmlhelp."
75+
76+
qthelp:
77+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
78+
@echo
79+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
80+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
81+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OpenERPTechnicalDocumentation.qhcp"
82+
@echo "To view the help file:"
83+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OpenERPTechnicalDocumentation.qhc"
84+
85+
devhelp:
86+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
87+
@echo
88+
@echo "Build finished."
89+
@echo "To view the help file:"
90+
@echo "# mkdir -p $$HOME/.local/share/devhelp/OpenERPTechnicalDocumentation"
91+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OpenERPTechnicalDocumentation"
92+
@echo "# devhelp"
93+
94+
epub:
95+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
96+
@echo
97+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
98+
99+
latex:
100+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
101+
@echo
102+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
103+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
104+
"(use \`make latexpdf' here to do that automatically)."
105+
106+
latexpdf:
107+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
108+
@echo "Running LaTeX files through pdflatex..."
109+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
110+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
111+
112+
text:
113+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
114+
@echo
115+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
116+
117+
man:
118+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
119+
@echo
120+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
121+
122+
texinfo:
123+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
124+
@echo
125+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
126+
@echo "Run \`make' in that directory to run these through makeinfo" \
127+
"(use \`make info' here to do that automatically)."
128+
129+
info:
130+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
131+
@echo "Running Texinfo files through makeinfo..."
132+
make -C $(BUILDDIR)/texinfo info
133+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
134+
135+
gettext:
136+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
137+
@echo
138+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
139+
140+
changes:
141+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
142+
@echo
143+
@echo "The overview file is in $(BUILDDIR)/changes."
144+
145+
linkcheck:
146+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
147+
@echo
148+
@echo "Link check complete; look for any errors in the above output " \
149+
"or in $(BUILDDIR)/linkcheck/output.txt."
150+
151+
doctest:
152+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
153+
@echo "Testing of doctests in the sources finished, look at the " \
154+
"results in $(BUILDDIR)/doctest/output.txt."

‎doc/_static/openerp.png

3.89 KB
Loading

‎doc/_templates/sidebarintro.html

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<p class="logo"><a href="http://doc.openerp.com/">
2+
<img class="logo" src="{{ pathto('_static/openerp.png', 1) }}" alt="Logo"/>
3+
</a></p>
4+
5+
<h3>Other Docs</h3>
6+
<ul>
7+
<li><a href="http://doc.openerp.com/trunk/developers">OpenERP Developers Documentation</a></li>
8+
<li><a href="http://doc.openerp.com/trunk/developers/web">OpenERP Web Developers Documentation</a></li>
9+
<li><a href="http://doc.openerp.com/trunk/users">OpenERP Users Documentation</a></li>
10+
</ul>
11+
12+
<h3>Useful Links</h3>
13+
<ul>
14+
<li><a href="http://www.openerp.com/">The OpenERP website</a></li>
15+
<li><a href="http://python.org/">The Python programming language</a></li>
16+
</ul>

‎doc/_templates/sidebarlogo.html

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<p class="logo"><a href="{{ pathto(master_doc) }}">
2+
<img class="logo" src="{{ pathto('_static/openerp.png', 1) }}" alt="Logo"/>
3+
</a></p>

‎doc/_themes/sphinx_bootstrap_theme/__init__.py

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
"""Sphinx bootstrap theme."""
2+
import os
3+
4+
VERSION = (0, 3, 8)
5+
6+
__version__ = ".".join(str(v) for v in VERSION)
7+
__version_full__ = __version__
8+
9+
def get_html_theme_path():
10+
"""Return list of HTML theme paths."""
11+
cur_dir = os.path.abspath(os.path.dirname(__file__))
12+
return [cur_dir]

‎doc/_themes/sphinx_bootstrap_theme/bootstrap/globaltoc.html

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<li class="dropdown globaltoc-container">
2+
<a role="button"
3+
id="dLabelGlobalToc"
4+
data-toggle="dropdown"
5+
data-target="#"
6+
href="{{ pathto(master_doc) }}">{{ theme_navbar_site_name }} <b class="caret"></b></a>
7+
<ul class="dropdown-menu globaltoc"
8+
role="menu"
9+
aria-labelledby="dLabelGlobalToc">{{ toctree(maxdepth=theme_globaltoc_depth|toint, collapse=False, includehidden=theme_globaltoc_includehidden|tobool) }}</ul>
10+
</li>

‎doc/_themes/sphinx_bootstrap_theme/bootstrap/layout.html

+142
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
{% extends "basic/layout.html" %}
2+
3+
{% set theme_css_files = [] %}
4+
{% if theme_bootstrap_version == "3" %}
5+
{% set bootstrap_version, bootstrap_additional_css, navbar_version = "3.1.0", "theme", "" %}
6+
{% set bs_span_prefix = "col-md-" %}
7+
{% else %}
8+
{% set bootstrap_version, bootstrap_additional_css, navbar_version = "2.3.2", "responsive", "-2" %}
9+
{% set bs_span_prefix = "span" %}
10+
{% endif %}
11+
12+
{% if theme_bootswatch_theme %}
13+
{# BS2 needs "bootstrap-responsive.css". BS3 doesn't. #}
14+
{% if theme_bootstrap_version == "3" %}
15+
{% set theme_css_files = theme_css_files + [
16+
'_static/bootswatch-' + bootstrap_version + '/' + theme_bootswatch_theme + '/bootstrap.min.css',
17+
'_static/bootstrap-sphinx.css'
18+
]
19+
%}
20+
{% else %}
21+
{% set theme_css_files = theme_css_files + [
22+
'_static/bootswatch-' + bootstrap_version + '/' + theme_bootswatch_theme + '/bootstrap.min.css',
23+
'_static/bootstrap-' + bootstrap_version + '/css/bootstrap-' + bootstrap_additional_css + '.min.css',
24+
'_static/bootstrap-sphinx.css'
25+
]
26+
%}
27+
{% endif %}
28+
{% else %}
29+
{% set theme_css_files = theme_css_files + [
30+
'_static/bootstrap-' + bootstrap_version + '/css/bootstrap.min.css',
31+
'_static/bootstrap-' + bootstrap_version + '/css/bootstrap-' + bootstrap_additional_css + '.min.css',
32+
'_static/bootstrap-sphinx.css'
33+
]
34+
%}
35+
{% endif %}
36+
37+
{% if not bootswatch_css_custom %}
38+
{% set bootswatch_css_custom = [] %}
39+
{% endif %}
40+
{% set css_files = css_files + theme_css_files + bootswatch_css_custom %}
41+
42+
{% set script_files = script_files + [
43+
'_static/js/jquery-1.11.0.min.js',
44+
'_static/js/jquery-fix.js',
45+
'_static/bootstrap-' + bootstrap_version + '/js/bootstrap.min.js',
46+
'_static/bootstrap-sphinx.js'
47+
]
48+
%}
49+
50+
{%- set render_sidebar = (not embedded) and (not theme_nosidebar|tobool) and sidebars %}
51+
52+
{%- set bs_content_width = render_sidebar and "9" or "12"%}
53+
54+
{%- block doctype -%}
55+
<!DOCTYPE html>
56+
{%- endblock %}
57+
58+
{# Sidebar: Rework into our Bootstrap nav section. #}
59+
{% macro navBar() %}
60+
{% include "navbar" + navbar_version + ".html" %}
61+
{% endmacro %}
62+
63+
{% if theme_bootstrap_version == "3" %}
64+
{%- macro bsidebar() %}
65+
{%- if render_sidebar %}
66+
<div class="{{ bs_span_prefix }}3">
67+
<div id="sidebar" class="bs-sidenav" role="complementary">
68+
{%- for sidebartemplate in sidebars %}
69+
{%- include sidebartemplate %}
70+
{%- endfor %}
71+
</div>
72+
</div>
73+
{%- endif %}
74+
{%- endmacro %}
75+
{% else %}
76+
{%- macro bsidebar() %}
77+
{%- if render_sidebar %}
78+
<div class="{{ bs_span_prefix }}3">
79+
<div id="sidebar" class="bs-sidenav well" data-spy="affix">
80+
{%- for sidebartemplate in sidebars %}
81+
{%- include sidebartemplate %}
82+
{%- endfor %}
83+
</div>
84+
</div>
85+
{%- endif %}
86+
{%- endmacro %}
87+
{% endif %}
88+
89+
{%- block extrahead %}
90+
<meta charset='utf-8'>
91+
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
92+
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
93+
<meta name="apple-mobile-web-app-capable" content="yes">
94+
{% endblock %}
95+
96+
{# Silence the sidebar's, relbar's #}
97+
{% block header %}{% endblock %}
98+
{% block relbar1 %}{% endblock %}
99+
{% block relbar2 %}{% endblock %}
100+
{% block sidebarsourcelink %}{% endblock %}
101+
102+
{%- block content %}
103+
{{ navBar() }}
104+
<div class="container">
105+
<div class="row">
106+
{%- block sidebar1 %}{{ bsidebar() }}{% endblock %}
107+
<div class="{{ bs_span_prefix }}{{ bs_content_width }}">
108+
{% block body %}{% endblock %}
109+
</div>
110+
{% block sidebar2 %} {# possible location for sidebar #} {% endblock %}
111+
</div>
112+
</div>
113+
{%- endblock %}
114+
115+
{%- block footer %}
116+
<footer class="footer">
117+
<div class="container">
118+
<p class="pull-right">
119+
<a href="#">Back to top</a>
120+
{% if theme_source_link_position == "footer" %}
121+
<br/>
122+
{% include "sourcelink.html" %}
123+
{% endif %}
124+
</p>
125+
<p>
126+
{%- if show_copyright %}
127+
{%- if hasdoc('copyright') %}
128+
{% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}<br/>
129+
{%- else %}
130+
{% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}<br/>
131+
{%- endif %}
132+
{%- endif %}
133+
{%- if last_updated %}
134+
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}<br/>
135+
{%- endif %}
136+
{%- if show_sphinx %}
137+
{% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}<br/>
138+
{%- endif %}
139+
</p>
140+
</div>
141+
</footer>
142+
{%- endblock %}

‎doc/_themes/sphinx_bootstrap_theme/bootstrap/localtoc.html

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{{ toc }}

‎doc/_themes/sphinx_bootstrap_theme/bootstrap/navbar-2.html

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<div id="navbar" class="{{ theme_navbar_class }} {% if theme_navbar_fixed_top == 'true' -%} navbar-fixed-top{%- endif -%}">
2+
<div class="navbar-inner">
3+
<div class="container">
4+
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
5+
<button class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
6+
<span class="icon-bar"></span>
7+
<span class="icon-bar"></span>
8+
<span class="icon-bar"></span>
9+
</button>
10+
11+
<a class="brand" href="{{ pathto(master_doc) }}">
12+
{%- block sidebarlogo %}
13+
{%- if logo %}<img src="{{ pathto('_static/' + logo, 1) }}">{%- endif %}
14+
{%- endblock %}
15+
{% if theme_navbar_title -%}{{ theme_navbar_title|e }}{%- else -%}{{ project|e }}{%- endif -%}
16+
</a>
17+
<span class="navbar-text pull-left"><b>{{ version|e }}</b></span>
18+
19+
<div class="nav-collapse">
20+
<ul class="nav">
21+
<li class="divider-vertical"></li>
22+
{% if theme_navbar_links %}
23+
{%- for link in theme_navbar_links %}
24+
<li><a href="{{ pathto(*link[1:]) }}">{{ link[0] }}</a></li>
25+
{%- endfor %}
26+
{% endif %}
27+
{% block navbartoc %}
28+
{% include "globaltoc.html" %}
29+
{% if theme_navbar_pagenav %}
30+
{% include "navbartoc.html" %}
31+
{% endif %}
32+
{% endblock %}
33+
{% if theme_navbar_sidebarrel %}
34+
{% block sidebarrel %}
35+
{% include "relations.html" %}
36+
{% endblock %}
37+
{% endif %}
38+
{% block navbarextra %}
39+
{% endblock %}
40+
{% if theme_source_link_position == "nav" %}
41+
<li>{% include "sourcelink.html" %}</li>
42+
{% endif %}
43+
</ul>
44+
45+
{% block navbarsearch %}
46+
{% include "navbarsearchbox.html" %}
47+
{% endblock %}
48+
</div>
49+
</div>
50+
</div>
51+
</div>

0 commit comments

Comments
 (0)