Skip to content

Commit fac9f0b

Browse files
author
Ivan Yelizariev
committed
init upload
0 parents  commit fac9f0b

10 files changed

+926
-0
lines changed

Diff for: .gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
_build

Diff for: .travis.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
language: python
2+
3+
python:
4+
- "2.7"
5+
6+
sudo: false
7+
8+
install:
9+
- pip install -r requirements.txt
10+
11+
script:
12+
- mkdir docs/_static; cd docs; sphinx-build -nW -b html -D exclude_patterns=dev/docs/templates/* -d _build/doctrees . _build/html
13+
14+
notifications:
15+
email: false

Diff for: LICENSE

+617
Large diffs are not rendered by default.

Diff for: README.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# odoo-development
2+
3+
4+
# How to contribute
5+
6+
## Initialization
7+
8+
* Fork this repo
9+
* Clone to your machine
10+
* Install dependencies:
11+
12+
sudo pip install sphinx sphinx-autobuild
13+
sudo pip install sphinx_rtd_theme
14+
15+
## Contribution
16+
17+
* Edit files in the repo. Check documentations:
18+
19+
* http://www.sphinx-doc.org/en/stable/rest.html
20+
* http://www.sphinx-doc.org/en/stable/domains.html
21+
* http://www.sphinx-doc.org/en/stable/markup/index.html
22+
* [images.md](images.md)
23+
24+
* Try it out:
25+
26+
cd /path/to/odoo-development/docs
27+
make html
28+
29+
# (check warningn and errors in compilation logs and fix them if needed)
30+
31+
# open result
32+
google-chrome _build/html/index.html
33+
34+
* Make commits, push, create Pull Request

Diff for: docs/Makefile

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SOURCEDIR = .
8+
BUILDDIR = _build
9+
10+
# Put it first so that "make" without argument is like "make help".
11+
help:
12+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
13+
14+
.PHONY: help Makefile
15+
16+
# Catch-all target: route all unknown targets to Sphinx using the new
17+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
18+
%: Makefile
19+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

Diff for: docs/conf.py

+173
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
# -*- coding: utf-8 -*-
2+
#
3+
# Configuration file for the Sphinx documentation builder.
4+
#
5+
# This file does only contain a selection of the most common options. For a
6+
# full list see the documentation:
7+
# http://www.sphinx-doc.org/en/master/config
8+
9+
# -- Path setup --------------------------------------------------------------
10+
11+
# If extensions (or modules to document with autodoc) are in another directory,
12+
# add these directories to sys.path here. If the directory is relative to the
13+
# documentation root, use os.path.abspath to make it absolute, like shown here.
14+
#
15+
# import os
16+
# import sys
17+
# sys.path.insert(0, os.path.abspath('.'))
18+
19+
20+
# -- Project information -----------------------------------------------------
21+
22+
project = u'odoo-test.sh'
23+
copyright = u'2019, IT-Projects LLC'
24+
author = u'IT-Projects LLC'
25+
26+
# The short X.Y version
27+
version = u''
28+
# The full version, including alpha/beta/rc tags
29+
release = u''
30+
31+
32+
# -- General configuration ---------------------------------------------------
33+
34+
# If your documentation needs a minimal Sphinx version, state it here.
35+
#
36+
# needs_sphinx = '1.0'
37+
38+
# Add any Sphinx extension module names here, as strings. They can be
39+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
40+
# ones.
41+
extensions = [
42+
]
43+
44+
# Add any paths that contain templates here, relative to this directory.
45+
templates_path = ['_templates']
46+
47+
# The suffix(es) of source filenames.
48+
# You can specify multiple suffix as a list of string:
49+
#
50+
# source_suffix = ['.rst', '.md']
51+
source_suffix = '.rst'
52+
53+
# The master toctree document.
54+
master_doc = 'index'
55+
56+
# The language for content autogenerated by Sphinx. Refer to documentation
57+
# for a list of supported languages.
58+
#
59+
# This is also used if you do content translation via gettext catalogs.
60+
# Usually you set "language" from the command line for these cases.
61+
language = None
62+
63+
# List of patterns, relative to source directory, that match files and
64+
# directories to ignore when looking for source files.
65+
# This pattern also affects html_static_path and html_extra_path.
66+
exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store']
67+
68+
# The name of the Pygments (syntax highlighting) style to use.
69+
pygments_style = None
70+
71+
72+
# -- Options for HTML output -------------------------------------------------
73+
74+
# The theme to use for HTML and HTML Help pages. See the documentation for
75+
# a list of builtin themes.
76+
#
77+
html_theme = 'alabaster'
78+
79+
# Theme options are theme-specific and customize the look and feel of a theme
80+
# further. For a list of options available for each theme, see the
81+
# documentation.
82+
#
83+
# html_theme_options = {}
84+
85+
# Add any paths that contain custom static files (such as style sheets) here,
86+
# relative to this directory. They are copied after the builtin static files,
87+
# so a file named "default.css" will overwrite the builtin "default.css".
88+
html_static_path = ['_static']
89+
90+
# Custom sidebar templates, must be a dictionary that maps document names
91+
# to template names.
92+
#
93+
# The default sidebars (for documents that don't match any pattern) are
94+
# defined by theme itself. Builtin themes are using these templates by
95+
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
96+
# 'searchbox.html']``.
97+
#
98+
# html_sidebars = {}
99+
100+
101+
# -- Options for HTMLHelp output ---------------------------------------------
102+
103+
# Output file base name for HTML help builder.
104+
htmlhelp_basename = 'odoo-testshdoc'
105+
106+
107+
# -- Options for LaTeX output ------------------------------------------------
108+
109+
latex_elements = {
110+
# The paper size ('letterpaper' or 'a4paper').
111+
#
112+
# 'papersize': 'letterpaper',
113+
114+
# The font size ('10pt', '11pt' or '12pt').
115+
#
116+
# 'pointsize': '10pt',
117+
118+
# Additional stuff for the LaTeX preamble.
119+
#
120+
# 'preamble': '',
121+
122+
# Latex figure (float) alignment
123+
#
124+
# 'figure_align': 'htbp',
125+
}
126+
127+
# Grouping the document tree into LaTeX files. List of tuples
128+
# (source start file, target name, title,
129+
# author, documentclass [howto, manual, or own class]).
130+
latex_documents = [
131+
(master_doc, 'odoo-testsh.tex', u'odoo-test.sh Documentation',
132+
u'IT-Projects LLC', 'manual'),
133+
]
134+
135+
136+
# -- Options for manual page output ------------------------------------------
137+
138+
# One entry per manual page. List of tuples
139+
# (source start file, name, description, authors, manual section).
140+
man_pages = [
141+
(master_doc, 'odoo-testsh', u'odoo-test.sh Documentation',
142+
[author], 1)
143+
]
144+
145+
146+
# -- Options for Texinfo output ----------------------------------------------
147+
148+
# Grouping the document tree into Texinfo files. List of tuples
149+
# (source start file, target name, title, author,
150+
# dir menu entry, description, category)
151+
texinfo_documents = [
152+
(master_doc, 'odoo-testsh', u'odoo-test.sh Documentation',
153+
author, 'odoo-testsh', 'One line description of project.',
154+
'Miscellaneous'),
155+
]
156+
157+
158+
# -- Options for Epub output -------------------------------------------------
159+
160+
# Bibliographic Dublin Core info.
161+
epub_title = project
162+
163+
# The unique identifier of the text. This can be a ISBN number
164+
# or the project homepage.
165+
#
166+
# epub_identifier = ''
167+
168+
# A unique identification for the text.
169+
#
170+
# epub_uid = ''
171+
172+
# A list of files that should not be packed into the epub file.
173+
epub_exclude_files = ['search.html']

Diff for: docs/index.rst

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. odoo-test.sh documentation master file, created by
2+
sphinx-quickstart on Tue Apr 30 11:52:24 2019.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to odoo-test.sh's documentation!
7+
========================================
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
:caption: Contents:
12+
13+
14+
15+
Indices and tables
16+
==================
17+
18+
* :ref:`genindex`
19+
* :ref:`modindex`
20+
* :ref:`search`

Diff for: docs/make.bat

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=.
11+
set BUILDDIR=_build
12+
13+
if "%1" == "" goto help
14+
15+
%SPHINXBUILD% >NUL 2>NUL
16+
if errorlevel 9009 (
17+
echo.
18+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19+
echo.installed, then set the SPHINXBUILD environment variable to point
20+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
21+
echo.may add the Sphinx directory to PATH.
22+
echo.
23+
echo.If you don't have Sphinx installed, grab it from
24+
echo.http://sphinx-doc.org/
25+
exit /b 1
26+
)
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
33+
34+
:end
35+
popd

Diff for: images.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Images
2+
======
3+
4+
Images must be put to ``docs/images/`` directory.
5+
6+
Then use a code:
7+
8+
.. image:: ../../path/to/image.png
9+
10+
Maximum size for image is 695 px.

Diff for: requirements.txt

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
sphinx
2+
sphinx_rtd_theme

0 commit comments

Comments
 (0)