rezometz/re2o
8
0
Fork 0
mirror of https://gitlab2.federez.net/re2o/re2o synced 2024-11-22 11:23:10 +00:00
Code Issues Releases Wiki Activity

Génération de documentation via Sphinx.

Browse source
This commit is contained in:
LEVY-FALK Hugo 2017-12-27 12:30:48 +01:00 committed by root
parent 09157a6a0d
commit 715f2be028
22 changed files with 3335 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.gitignore vendored
View file

@ -5,3 +5,4 @@ re2o.png
__pycache__/*
static_files/*
static/logo/*
doc/build/

225
doc/Makefile Normal file
View file

@ -0,0 +1,225 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
.PHONY: help
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " applehelp to make an Apple Help Book"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " epub3 to make an epub3"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " coverage to run coverage check of the documentation (if enabled)"
@echo " dummy to check syntax errors of document sources"
.PHONY: clean
clean:
rm -rf $(BUILDDIR)/*
.PHONY: html
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
.PHONY: dirhtml
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
.PHONY: singlehtml
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
.PHONY: pickle
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
.PHONY: json
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
.PHONY: htmlhelp
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
.PHONY: qthelp
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Re2o.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Re2o.qhc"
.PHONY: applehelp
applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@echo
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
@echo "N.B. You won't be able to view it unless you put it in" \
"~/Library/Documentation/Help or install it in your application" \
"bundle."
.PHONY: devhelp
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/Re2o"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Re2o"
@echo "# devhelp"
.PHONY: epub
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
.PHONY: epub3
epub3:
$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
@echo
@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
.PHONY: latex
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
.PHONY: latexpdf
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
.PHONY: latexpdfja
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
.PHONY: text
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
.PHONY: man
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
.PHONY: texinfo
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
.PHONY: info
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
.PHONY: gettext
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
.PHONY: changes
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
.PHONY: linkcheck
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
.PHONY: doctest
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
.PHONY: coverage
coverage:
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo "Testing of coverage in the sources finished, look at the " \
"results in $(BUILDDIR)/coverage/python.txt."
.PHONY: xml
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
.PHONY: pseudoxml
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
.PHONY: dummy
dummy:
$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
@echo
@echo "Build finished. Dummy builder generates no files."

281
doc/make.bat Normal file
View file

@ -0,0 +1,281 @@
@ECHO OFF
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set BUILDDIR=build
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
set I18NSPHINXOPTS=%SPHINXOPTS% source
if NOT "%PAPER%" == "" (
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
)
if "%1" == "" goto help
if "%1" == "help" (
:help
echo.Please use `make ^<target^>` where ^<target^> is one of
echo. html to make standalone HTML files
echo. dirhtml to make HTML files named index.html in directories
echo. singlehtml to make a single large HTML file
echo. pickle to make pickle files
echo. json to make JSON files
echo. htmlhelp to make HTML files and a HTML help project
echo. qthelp to make HTML files and a qthelp project
echo. devhelp to make HTML files and a Devhelp project
echo. epub to make an epub
echo. epub3 to make an epub3
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
echo. text to make text files
echo. man to make manual pages
echo. texinfo to make Texinfo files
echo. gettext to make PO message catalogs
echo. changes to make an overview over all changed/added/deprecated items
echo. xml to make Docutils-native XML files
echo. pseudoxml to make pseudoxml-XML files for display purposes
echo. linkcheck to check all external links for integrity
echo. doctest to run all doctests embedded in the documentation if enabled
echo. coverage to run coverage check of the documentation if enabled
echo. dummy to check syntax errors of document sources
goto end
)
if "%1" == "clean" (
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
del /q /s %BUILDDIR%\*
goto end
)
REM Check if sphinx-build is available and fallback to Python version if any
%SPHINXBUILD% 1>NUL 2>NUL
if errorlevel 9009 goto sphinx_python
goto sphinx_ok
:sphinx_python
set SPHINXBUILD=python -m sphinx.__init__
%SPHINXBUILD% 2> nul
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
:sphinx_ok
if "%1" == "html" (
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
goto end
)
if "%1" == "dirhtml" (
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
goto end
)
if "%1" == "singlehtml" (
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
goto end
)
if "%1" == "pickle" (
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the pickle files.
goto end
)
if "%1" == "json" (
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the JSON files.
goto end
)
if "%1" == "htmlhelp" (
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run HTML Help Workshop with the ^
.hhp project file in %BUILDDIR%/htmlhelp.
goto end
)
if "%1" == "qthelp" (
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Re2o.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Re2o.ghc
goto end
)
if "%1" == "devhelp" (
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished.
goto end
)
if "%1" == "epub" (
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The epub file is in %BUILDDIR%/epub.
goto end
)
if "%1" == "epub3" (
%SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The epub3 file is in %BUILDDIR%/epub3.
goto end
)
if "%1" == "latex" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
if errorlevel 1 exit /b 1
echo.
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "latexpdf" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
cd %BUILDDIR%/latex
make all-pdf
cd %~dp0
echo.
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "latexpdfja" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
cd %BUILDDIR%/latex
make all-pdf-ja
cd %~dp0
echo.
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "text" (
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The text files are in %BUILDDIR%/text.
goto end
)
if "%1" == "man" (
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The manual pages are in %BUILDDIR%/man.
goto end
)
if "%1" == "texinfo" (
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
goto end
)
if "%1" == "gettext" (
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
goto end
)
if "%1" == "changes" (
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
if errorlevel 1 exit /b 1
echo.
echo.The overview file is in %BUILDDIR%/changes.
goto end
)
if "%1" == "linkcheck" (
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
if errorlevel 1 exit /b 1
echo.
echo.Link check complete; look for any errors in the above output ^
or in %BUILDDIR%/linkcheck/output.txt.
goto end
)
if "%1" == "doctest" (
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
if errorlevel 1 exit /b 1
echo.
echo.Testing of doctests in the sources finished, look at the ^
results in %BUILDDIR%/doctest/output.txt.
goto end
)
if "%1" == "coverage" (
%SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage
if errorlevel 1 exit /b 1
echo.
echo.Testing of coverage in the sources finished, look at the ^
results in %BUILDDIR%/coverage/python.txt.
goto end
)
if "%1" == "xml" (
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The XML files are in %BUILDDIR%/xml.
goto end
)
if "%1" == "pseudoxml" (
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
goto end
)
if "%1" == "dummy" (
%SPHINXBUILD% -b dummy %ALLSPHINXOPTS% %BUILDDIR%/dummy
if errorlevel 1 exit /b 1
echo.
echo.Build finished. Dummy builder generates no files.
goto end
)
:end

230
doc/source/code/cotisations.migrations.rst Normal file
View file

@ -0,0 +1,230 @@
cotisations.migrations package
==============================
Submodules
----------
cotisations.migrations.0001_initial module
------------------------------------------
.. automodule:: cotisations.migrations.0001_initial
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0002_remove_facture_article module
---------------------------------------------------------
.. automodule:: cotisations.migrations.0002_remove_facture_article
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0003_auto_20160702_1448 module
-----------------------------------------------------
.. automodule:: cotisations.migrations.0003_auto_20160702_1448
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0004_auto_20160702_1528 module
-----------------------------------------------------
.. automodule:: cotisations.migrations.0004_auto_20160702_1528
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0005_auto_20160702_1532 module
-----------------------------------------------------
.. automodule:: cotisations.migrations.0005_auto_20160702_1532
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0006_auto_20160702_1534 module
-----------------------------------------------------
.. automodule:: cotisations.migrations.0006_auto_20160702_1534
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0007_auto_20160702_1543 module
-----------------------------------------------------
.. automodule:: cotisations.migrations.0007_auto_20160702_1543
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0008_auto_20160702_1614 module
-----------------------------------------------------
.. automodule:: cotisations.migrations.0008_auto_20160702_1614
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0009_remove_cotisation_user module
---------------------------------------------------------
.. automodule:: cotisations.migrations.0009_remove_cotisation_user
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0010_auto_20160702_1840 module
-----------------------------------------------------
.. automodule:: cotisations.migrations.0010_auto_20160702_1840
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0011_auto_20160702_1911 module
-----------------------------------------------------
.. automodule:: cotisations.migrations.0011_auto_20160702_1911
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0012_auto_20160704_0118 module
-----------------------------------------------------
.. automodule:: cotisations.migrations.0012_auto_20160704_0118
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0013_auto_20160711_2240 module
-----------------------------------------------------
.. automodule:: cotisations.migrations.0013_auto_20160711_2240
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0014_auto_20160712_0245 module
-----------------------------------------------------
.. automodule:: cotisations.migrations.0014_auto_20160712_0245
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0015_auto_20160714_2142 module
-----------------------------------------------------
.. automodule:: cotisations.migrations.0015_auto_20160714_2142
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0016_auto_20160715_0110 module
-----------------------------------------------------
.. automodule:: cotisations.migrations.0016_auto_20160715_0110
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0017_auto_20170718_2329 module
-----------------------------------------------------
.. automodule:: cotisations.migrations.0017_auto_20170718_2329
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0018_paiement_type_paiement module
---------------------------------------------------------
.. automodule:: cotisations.migrations.0018_paiement_type_paiement
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0019_auto_20170819_0055 module
-----------------------------------------------------
.. automodule:: cotisations.migrations.0019_auto_20170819_0055
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0020_auto_20170819_0057 module
-----------------------------------------------------
.. automodule:: cotisations.migrations.0020_auto_20170819_0057
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0021_auto_20170819_0104 module
-----------------------------------------------------
.. automodule:: cotisations.migrations.0021_auto_20170819_0104
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0022_auto_20170824_0128 module
-----------------------------------------------------
.. automodule:: cotisations.migrations.0022_auto_20170824_0128
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0023_auto_20170902_1303 module
-----------------------------------------------------
.. automodule:: cotisations.migrations.0023_auto_20170902_1303
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0024_auto_20171015_2033 module
-----------------------------------------------------
.. automodule:: cotisations.migrations.0024_auto_20171015_2033
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0025_article_type_user module
----------------------------------------------------
.. automodule:: cotisations.migrations.0025_article_type_user
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0026_auto_20171028_0126 module
-----------------------------------------------------
.. automodule:: cotisations.migrations.0026_auto_20171028_0126
:members:
:undoc-members:
:show-inheritance:
cotisations.migrations.0027_auto_20171029_1156 module
-----------------------------------------------------
.. automodule:: cotisations.migrations.0027_auto_20171029_1156
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cotisations.migrations
:members:
:undoc-members:
:show-inheritance:

77
doc/source/code/cotisations.rst Normal file
View file

@ -0,0 +1,77 @@
cotisations package
===================
Subpackages
-----------
.. toctree::
cotisations.migrations
Submodules
----------
cotisations.admin module
------------------------
.. automodule:: cotisations.admin
:members:
:undoc-members:
:show-inheritance:
cotisations.forms module
------------------------
.. automodule:: cotisations.forms
:members:
:undoc-members:
:show-inheritance:
cotisations.models module
-------------------------
.. automodule:: cotisations.models
:members:
:undoc-members:
:show-inheritance:
cotisations.tests module
------------------------
.. automodule:: cotisations.tests
:members:
:undoc-members:
:show-inheritance:
cotisations.tex module
----------------------
.. automodule:: cotisations.tex
:members:
:undoc-members:
:show-inheritance:
cotisations.urls module
-----------------------
.. automodule:: cotisations.urls
:members:
:undoc-members:
:show-inheritance:
cotisations.views module
------------------------
.. automodule:: cotisations.views
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cotisations
:members:
:undoc-members:
:show-inheritance:

61
doc/source/code/logs.rst Normal file
View file

@ -0,0 +1,61 @@
logs package
============
Subpackages
-----------
.. toctree::
logs.templatetags
Submodules
----------
logs.admin module
-----------------
.. automodule:: logs.admin
:members:
:undoc-members:
:show-inheritance:
logs.models module
------------------
.. automodule:: logs.models
:members:
:undoc-members:
:show-inheritance:
logs.tests module
-----------------
.. automodule:: logs.tests
:members:
:undoc-members:
:show-inheritance:
logs.urls module
----------------
.. automodule:: logs.urls
:members:
:undoc-members:
:show-inheritance:
logs.views module
-----------------
.. automodule:: logs.views
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: logs
:members:
:undoc-members:
:show-inheritance:

22
doc/source/code/logs.templatetags.rst Normal file
View file

@ -0,0 +1,22 @@
logs.templatetags package
=========================
Submodules
----------
logs.templatetags.logs_extra module
-----------------------------------
.. automodule:: logs.templatetags.logs_extra
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: logs.templatetags
:members:
:undoc-members:
:show-inheritance:

566
doc/source/code/machines.migrations.rst Normal file
View file

@ -0,0 +1,566 @@
machines.migrations package
===========================
Submodules
----------
machines.migrations.0001_initial module
---------------------------------------
.. automodule:: machines.migrations.0001_initial
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0002_auto_20160703_1444 module
--------------------------------------------------
.. automodule:: machines.migrations.0002_auto_20160703_1444
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0003_auto_20160703_1450 module
--------------------------------------------------
.. automodule:: machines.migrations.0003_auto_20160703_1450
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0004_auto_20160703_1451 module
--------------------------------------------------
.. automodule:: machines.migrations.0004_auto_20160703_1451
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0005_auto_20160703_1523 module
--------------------------------------------------
.. automodule:: machines.migrations.0005_auto_20160703_1523
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0006_auto_20160703_1813 module
--------------------------------------------------
.. automodule:: machines.migrations.0006_auto_20160703_1813
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0007_auto_20160703_1816 module
--------------------------------------------------
.. automodule:: machines.migrations.0007_auto_20160703_1816
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0008_remove_interface_ipv6 module
-----------------------------------------------------
.. automodule:: machines.migrations.0008_remove_interface_ipv6
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0009_auto_20160703_2358 module
--------------------------------------------------
.. automodule:: machines.migrations.0009_auto_20160703_2358
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0010_auto_20160704_0104 module
--------------------------------------------------
.. automodule:: machines.migrations.0010_auto_20160704_0104
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0011_auto_20160704_0105 module
--------------------------------------------------
.. automodule:: machines.migrations.0011_auto_20160704_0105
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0012_auto_20160704_0118 module
--------------------------------------------------
.. automodule:: machines.migrations.0012_auto_20160704_0118
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0013_auto_20160705_1014 module
--------------------------------------------------
.. automodule:: machines.migrations.0013_auto_20160705_1014
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0014_auto_20160706_1220 module
--------------------------------------------------
.. automodule:: machines.migrations.0014_auto_20160706_1220
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0015_auto_20160707_0105 module
--------------------------------------------------
.. automodule:: machines.migrations.0015_auto_20160707_0105
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0016_auto_20160708_1633 module
--------------------------------------------------
.. automodule:: machines.migrations.0016_auto_20160708_1633
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0017_auto_20160708_1645 module
--------------------------------------------------
.. automodule:: machines.migrations.0017_auto_20160708_1645
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0018_auto_20160708_1813 module
--------------------------------------------------
.. automodule:: machines.migrations.0018_auto_20160708_1813
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0019_auto_20160718_1141 module
--------------------------------------------------
.. automodule:: machines.migrations.0019_auto_20160718_1141
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0020_auto_20160718_1849 module
--------------------------------------------------
.. automodule:: machines.migrations.0020_auto_20160718_1849
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0021_auto_20161006_1943 module
--------------------------------------------------
.. automodule:: machines.migrations.0021_auto_20161006_1943
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0022_auto_20161011_1829 module
--------------------------------------------------
.. automodule:: machines.migrations.0022_auto_20161011_1829
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0023_iplist_ip_type module
----------------------------------------------
.. automodule:: machines.migrations.0023_iplist_ip_type
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0024_machinetype_need_infra module
------------------------------------------------------
.. automodule:: machines.migrations.0024_machinetype_need_infra
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0025_auto_20161023_0038 module
--------------------------------------------------
.. automodule:: machines.migrations.0025_auto_20161023_0038
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0026_auto_20161026_1348 module
--------------------------------------------------
.. automodule:: machines.migrations.0026_auto_20161026_1348
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0027_alias module
-------------------------------------
.. automodule:: machines.migrations.0027_alias
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0028_iptype_domaine_ip module
-------------------------------------------------
.. automodule:: machines.migrations.0028_iptype_domaine_ip
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0029_iptype_domaine_range module
----------------------------------------------------
.. automodule:: machines.migrations.0029_iptype_domaine_range
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0030_auto_20161118_1730 module
--------------------------------------------------
.. automodule:: machines.migrations.0030_auto_20161118_1730
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0031_auto_20161119_1709 module
--------------------------------------------------
.. automodule:: machines.migrations.0031_auto_20161119_1709
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0032_auto_20161119_1850 module
--------------------------------------------------
.. automodule:: machines.migrations.0032_auto_20161119_1850
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0033_extension_need_infra module
----------------------------------------------------
.. automodule:: machines.migrations.0033_extension_need_infra
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0034_iplist_need_infra module
-------------------------------------------------
.. automodule:: machines.migrations.0034_iplist_need_infra
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0035_auto_20161224_1201 module
--------------------------------------------------
.. automodule:: machines.migrations.0035_auto_20161224_1201
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0036_auto_20161224_1204 module
--------------------------------------------------
.. automodule:: machines.migrations.0036_auto_20161224_1204
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0037_domain_cname module
--------------------------------------------
.. automodule:: machines.migrations.0037_domain_cname
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0038_auto_20161224_1721 module
--------------------------------------------------
.. automodule:: machines.migrations.0038_auto_20161224_1721
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0039_auto_20161224_1732 module
--------------------------------------------------
.. automodule:: machines.migrations.0039_auto_20161224_1732
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0040_remove_interface_dns module
----------------------------------------------------
.. automodule:: machines.migrations.0040_remove_interface_dns
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0041_remove_ns_interface module
---------------------------------------------------
.. automodule:: machines.migrations.0041_remove_ns_interface
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0042_ns_ns module
-------------------------------------
.. automodule:: machines.migrations.0042_ns_ns
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0043_auto_20170721_0350 module
--------------------------------------------------
.. automodule:: machines.migrations.0043_auto_20170721_0350
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0044_auto_20170808_0233 module
--------------------------------------------------
.. automodule:: machines.migrations.0044_auto_20170808_0233
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0045_auto_20170808_0348 module
--------------------------------------------------
.. automodule:: machines.migrations.0045_auto_20170808_0348
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0046_auto_20170808_1423 module
--------------------------------------------------
.. automodule:: machines.migrations.0046_auto_20170808_1423
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0047_auto_20170809_0606 module
--------------------------------------------------
.. automodule:: machines.migrations.0047_auto_20170809_0606
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0048_auto_20170823_2315 module
--------------------------------------------------
.. automodule:: machines.migrations.0048_auto_20170823_2315
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0049_vlan module
------------------------------------
.. automodule:: machines.migrations.0049_vlan
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0050_auto_20170826_0022 module
--------------------------------------------------
.. automodule:: machines.migrations.0050_auto_20170826_0022
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0051_iptype_vlan module
-------------------------------------------
.. automodule:: machines.migrations.0051_iptype_vlan
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0052_auto_20170828_2322 module
--------------------------------------------------
.. automodule:: machines.migrations.0052_auto_20170828_2322
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0053_text module
------------------------------------
.. automodule:: machines.migrations.0053_text
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0054_text_zone module
-----------------------------------------
.. automodule:: machines.migrations.0054_text_zone
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0055_nas module
-----------------------------------
.. automodule:: machines.migrations.0055_nas
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0056_nas_port_access_mode module
----------------------------------------------------
.. automodule:: machines.migrations.0056_nas_port_access_mode
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0057_nas_autocapture_mac module
---------------------------------------------------
.. automodule:: machines.migrations.0057_nas_autocapture_mac
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0058_auto_20171002_0350 module
--------------------------------------------------
.. automodule:: machines.migrations.0058_auto_20171002_0350
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0059_iptype_prefix_v6 module
------------------------------------------------
.. automodule:: machines.migrations.0059_iptype_prefix_v6
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0060_iptype_ouverture_ports module
------------------------------------------------------
.. automodule:: machines.migrations.0060_iptype_ouverture_ports
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0061_auto_20171015_2033 module
--------------------------------------------------
.. automodule:: machines.migrations.0061_auto_20171015_2033
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0062_extension_origin_v6 module
---------------------------------------------------
.. automodule:: machines.migrations.0062_extension_origin_v6
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0063_auto_20171020_0040 module
--------------------------------------------------
.. automodule:: machines.migrations.0063_auto_20171020_0040
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0064_auto_20171115_0253 module
--------------------------------------------------
.. automodule:: machines.migrations.0064_auto_20171115_0253
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0065_auto_20171115_1514 module
--------------------------------------------------
.. automodule:: machines.migrations.0065_auto_20171115_1514
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0066_srv module
-----------------------------------
.. automodule:: machines.migrations.0066_srv
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0067_auto_20171116_0152 module
--------------------------------------------------
.. automodule:: machines.migrations.0067_auto_20171116_0152
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0068_auto_20171116_0252 module
--------------------------------------------------
.. automodule:: machines.migrations.0068_auto_20171116_0252
:members:
:undoc-members:
:show-inheritance:
machines.migrations.0069_auto_20171116_0822 module
--------------------------------------------------
.. automodule:: machines.migrations.0069_auto_20171116_0822
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: machines.migrations
:members:
:undoc-members:
:show-inheritance:

77
doc/source/code/machines.rst Normal file
View file

@ -0,0 +1,77 @@
machines package
================
Subpackages
-----------
.. toctree::
machines.migrations
Submodules
----------
machines.admin module
---------------------
.. automodule:: machines.admin
:members:
:undoc-members:
:show-inheritance:
machines.forms module
---------------------
.. automodule:: machines.forms
:members:
:undoc-members:
:show-inheritance:
machines.models module
----------------------
.. automodule:: machines.models
:members:
:undoc-members:
:show-inheritance:
machines.serializers module
---------------------------
.. automodule:: machines.serializers
:members:
:undoc-members:
:show-inheritance:
machines.tests module
---------------------
.. automodule:: machines.tests
:members:
:undoc-members:
:show-inheritance:
machines.urls module
--------------------
.. automodule:: machines.urls
:members:
:undoc-members:
:show-inheritance:
machines.views module
---------------------
.. automodule:: machines.views
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: machines
:members:
:undoc-members:
:show-inheritance:

7
doc/source/code/manage.rst Normal file
View file

@ -0,0 +1,7 @@
manage module
=============
.. automodule:: manage
:members:
:undoc-members:
:show-inheritance:

15
doc/source/code/modules.rst Normal file
View file

@ -0,0 +1,15 @@
re2o
====
.. toctree::
:maxdepth: 4
cotisations
logs
machines
manage
preferences
re2o
search
topologie
users

206
doc/source/code/preferences.migrations.rst Normal file
View file

@ -0,0 +1,206 @@
preferences.migrations package
==============================
Submodules
----------
preferences.migrations.0001_initial module
------------------------------------------
.. automodule:: preferences.migrations.0001_initial
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0002_auto_20170625_1923 module
-----------------------------------------------------
.. automodule:: preferences.migrations.0002_auto_20170625_1923
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0003_optionaluser_solde_negatif module
-------------------------------------------------------------
.. automodule:: preferences.migrations.0003_optionaluser_solde_negatif
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0004_assooption_services module
------------------------------------------------------
.. automodule:: preferences.migrations.0004_assooption_services
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0005_auto_20170824_0139 module
-----------------------------------------------------
.. automodule:: preferences.migrations.0005_auto_20170824_0139
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0006_auto_20170824_0143 module
-----------------------------------------------------
.. automodule:: preferences.migrations.0006_auto_20170824_0143
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0007_auto_20170824_2056 module
-----------------------------------------------------
.. automodule:: preferences.migrations.0007_auto_20170824_2056
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0008_auto_20170824_2122 module
-----------------------------------------------------
.. automodule:: preferences.migrations.0008_auto_20170824_2122
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0009_assooption_utilisateur_asso module
--------------------------------------------------------------
.. automodule:: preferences.migrations.0009_assooption_utilisateur_asso
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0010_auto_20170825_0459 module
-----------------------------------------------------
.. automodule:: preferences.migrations.0010_auto_20170825_0459
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0011_auto_20170825_2307 module
-----------------------------------------------------
.. automodule:: preferences.migrations.0011_auto_20170825_2307
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0012_generaloption_req_expire_hrs module
---------------------------------------------------------------
.. automodule:: preferences.migrations.0012_generaloption_req_expire_hrs
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0013_generaloption_site_name module
----------------------------------------------------------
.. automodule:: preferences.migrations.0013_generaloption_site_name
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0014_generaloption_email_from module
-----------------------------------------------------------
.. automodule:: preferences.migrations.0014_generaloption_email_from
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0015_optionaltopologie_radius_general_policy module
--------------------------------------------------------------------------
.. automodule:: preferences.migrations.0015_optionaltopologie_radius_general_policy
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0016_auto_20170902_1520 module
-----------------------------------------------------
.. automodule:: preferences.migrations.0016_auto_20170902_1520
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0017_mailmessageoption module
----------------------------------------------------
.. automodule:: preferences.migrations.0017_mailmessageoption
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0018_optionaltopologie_mac_autocapture module
--------------------------------------------------------------------
.. automodule:: preferences.migrations.0018_optionaltopologie_mac_autocapture
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0019_remove_optionaltopologie_mac_autocapture module
---------------------------------------------------------------------------
.. automodule:: preferences.migrations.0019_remove_optionaltopologie_mac_autocapture
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0020_optionalmachine_ipv6 module
-------------------------------------------------------
.. automodule:: preferences.migrations.0020_optionalmachine_ipv6
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0021_auto_20171015_1741 module
-----------------------------------------------------
.. automodule:: preferences.migrations.0021_auto_20171015_1741
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0022_auto_20171015_1758 module
-----------------------------------------------------
.. automodule:: preferences.migrations.0022_auto_20171015_1758
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0023_auto_20171015_2033 module
-----------------------------------------------------
.. automodule:: preferences.migrations.0023_auto_20171015_2033
:members:
:undoc-members:
:show-inheritance:
preferences.migrations.0024_optionaluser_all_can_create module
--------------------------------------------------------------
.. automodule:: preferences.migrations.0024_optionaluser_all_can_create
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: preferences.migrations
:members:
:undoc-members:
:show-inheritance:

77
doc/source/code/preferences.rst Normal file
View file

@ -0,0 +1,77 @@
preferences package
===================
Subpackages
-----------
.. toctree::
preferences.migrations
Submodules
----------
preferences.admin module
------------------------
.. automodule:: preferences.admin
:members:
:undoc-members:
:show-inheritance:
preferences.apps module
-----------------------
.. automodule:: preferences.apps
:members:
:undoc-members:
:show-inheritance:
preferences.forms module
------------------------
.. automodule:: preferences.forms
:members:
:undoc-members:
:show-inheritance:
preferences.models module
-------------------------
.. automodule:: preferences.models
:members:
:undoc-members:
:show-inheritance:
preferences.tests module
------------------------
.. automodule:: preferences.tests
:members:
:undoc-members:
:show-inheritance:
preferences.urls module
-----------------------
.. automodule:: preferences.urls
:members:
:undoc-members:
:show-inheritance:
preferences.views module
------------------------
.. automodule:: preferences.views
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: preferences
:members:
:undoc-members:
:show-inheritance:

93
doc/source/code/re2o.rst Normal file
View file

@ -0,0 +1,93 @@
re2o package
============
Subpackages
-----------
.. toctree::
re2o.templatetags
Submodules
----------
re2o.context_processors module
------------------------------
.. automodule:: re2o.context_processors
:members:
:undoc-members:
:show-inheritance:
re2o.login module
-----------------
.. automodule:: re2o.login
:members:
:undoc-members:
:show-inheritance:
re2o.settings module
--------------------
.. automodule:: re2o.settings
:members:
:undoc-members:
:show-inheritance:
re2o.settings_local.example module
----------------------------------
.. automodule:: re2o.settings_local.example
:members:
:undoc-members:
:show-inheritance:
re2o.settings_local module
--------------------------
.. automodule:: re2o.settings_local
:members:
:undoc-members:
:show-inheritance:
re2o.urls module
----------------
.. automodule:: re2o.urls
:members:
:undoc-members:
:show-inheritance:
re2o.utils module
-----------------
.. automodule:: re2o.utils
:members:
:undoc-members:
:show-inheritance:
re2o.views module
-----------------
.. automodule:: re2o.views
:members:
:undoc-members:
:show-inheritance:
re2o.wsgi module
----------------
.. automodule:: re2o.wsgi
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: re2o
:members:
:undoc-members:
:show-inheritance:

38
doc/source/code/re2o.templatetags.rst Normal file
View file

@ -0,0 +1,38 @@
re2o.templatetags package
=========================
Submodules
----------
re2o.templatetags.acl module
----------------------------
.. automodule:: re2o.templatetags.acl
:members:
:undoc-members:
:show-inheritance:
re2o.templatetags.massive_bootstrap_form module
-----------------------------------------------
.. automodule:: re2o.templatetags.massive_bootstrap_form
:members:
:undoc-members:
:show-inheritance:
re2o.templatetags.url_insert_param module
-----------------------------------------
.. automodule:: re2o.templatetags.url_insert_param
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: re2o.templatetags
:members:
:undoc-members:
:show-inheritance:

54
doc/source/code/search.rst Normal file
View file

@ -0,0 +1,54 @@
search package
==============
Submodules
----------
search.admin module
-------------------
.. automodule:: search.admin
:members:
:undoc-members:
:show-inheritance:
search.forms module
-------------------
.. automodule:: search.forms
:members:
:undoc-members:
:show-inheritance:
search.tests module
-------------------
.. automodule:: search.tests
:members:
:undoc-members:
:show-inheritance:
search.urls module
------------------
.. automodule:: search.urls
:members:
:undoc-members:
:show-inheritance:
search.views module
-------------------
.. automodule:: search.views
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: search
:members:
:undoc-members:
:show-inheritance:

286
doc/source/code/topologie.migrations.rst Normal file
View file

@ -0,0 +1,286 @@
topologie.migrations package
============================
Submodules
----------
topologie.migrations.0001_initial module
----------------------------------------
.. automodule:: topologie.migrations.0001_initial
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0002_auto_20160703_1118 module
---------------------------------------------------
.. automodule:: topologie.migrations.0002_auto_20160703_1118
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0003_room module
-------------------------------------
.. automodule:: topologie.migrations.0003_room
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0004_auto_20160703_1122 module
---------------------------------------------------
.. automodule:: topologie.migrations.0004_auto_20160703_1122
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0005_auto_20160703_1123 module
---------------------------------------------------
.. automodule:: topologie.migrations.0005_auto_20160703_1123
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0006_auto_20160703_1129 module
---------------------------------------------------
.. automodule:: topologie.migrations.0006_auto_20160703_1129
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0007_auto_20160703_1148 module
---------------------------------------------------
.. automodule:: topologie.migrations.0007_auto_20160703_1148
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0008_port_room module
------------------------------------------
.. automodule:: topologie.migrations.0008_port_room
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0009_auto_20160703_1200 module
---------------------------------------------------
.. automodule:: topologie.migrations.0009_auto_20160703_1200
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0010_auto_20160704_2148 module
---------------------------------------------------
.. automodule:: topologie.migrations.0010_auto_20160704_2148
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0011_auto_20160704_2153 module
---------------------------------------------------
.. automodule:: topologie.migrations.0011_auto_20160704_2153
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0012_port_machine_interface module
-------------------------------------------------------
.. automodule:: topologie.migrations.0012_port_machine_interface
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0013_port_related module
---------------------------------------------
.. automodule:: topologie.migrations.0013_port_related
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0014_auto_20160706_1238 module
---------------------------------------------------
.. automodule:: topologie.migrations.0014_auto_20160706_1238
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0015_auto_20160706_1452 module
---------------------------------------------------
.. automodule:: topologie.migrations.0015_auto_20160706_1452
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0016_auto_20160706_1531 module
---------------------------------------------------
.. automodule:: topologie.migrations.0016_auto_20160706_1531
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0017_auto_20160718_1141 module
---------------------------------------------------
.. automodule:: topologie.migrations.0017_auto_20160718_1141
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0018_room_details module
---------------------------------------------
.. automodule:: topologie.migrations.0018_room_details
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0019_auto_20161026_1348 module
---------------------------------------------------
.. automodule:: topologie.migrations.0019_auto_20161026_1348
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0020_auto_20161119_0033 module
---------------------------------------------------
.. automodule:: topologie.migrations.0020_auto_20161119_0033
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0021_port_radius module
--------------------------------------------
.. automodule:: topologie.migrations.0021_port_radius
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0022_auto_20161211_1622 module
---------------------------------------------------
.. automodule:: topologie.migrations.0022_auto_20161211_1622
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0023_auto_20170817_1654 module
---------------------------------------------------
.. automodule:: topologie.migrations.0023_auto_20170817_1654
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0023_auto_20170826_1530 module
---------------------------------------------------
.. automodule:: topologie.migrations.0023_auto_20170826_1530
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0024_auto_20170818_1021 module
---------------------------------------------------
.. automodule:: topologie.migrations.0024_auto_20170818_1021
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0024_auto_20170826_1800 module
---------------------------------------------------
.. automodule:: topologie.migrations.0024_auto_20170826_1800
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0025_merge_20170902_1242 module
----------------------------------------------------
.. automodule:: topologie.migrations.0025_merge_20170902_1242
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0026_auto_20170902_1245 module
---------------------------------------------------
.. automodule:: topologie.migrations.0026_auto_20170902_1245
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0027_auto_20170905_1442 module
---------------------------------------------------
.. automodule:: topologie.migrations.0027_auto_20170905_1442
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0028_auto_20170913_1503 module
---------------------------------------------------
.. automodule:: topologie.migrations.0028_auto_20170913_1503
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0029_auto_20171002_0334 module
---------------------------------------------------
.. automodule:: topologie.migrations.0029_auto_20171002_0334
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0030_auto_20171004_0235 module
---------------------------------------------------
.. automodule:: topologie.migrations.0030_auto_20171004_0235
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0031_auto_20171015_2033 module
---------------------------------------------------
.. automodule:: topologie.migrations.0031_auto_20171015_2033
:members:
:undoc-members:
:show-inheritance:
topologie.migrations.0032_auto_20171026_0338 module
---------------------------------------------------
.. automodule:: topologie.migrations.0032_auto_20171026_0338
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: topologie.migrations
:members:
:undoc-members:
:show-inheritance:

69
doc/source/code/topologie.rst Normal file
View file

@ -0,0 +1,69 @@
topologie package
=================
Subpackages
-----------
.. toctree::
topologie.migrations
Submodules
----------
topologie.admin module
----------------------
.. automodule:: topologie.admin
:members:
:undoc-members:
:show-inheritance:
topologie.forms module
----------------------
.. automodule:: topologie.forms
:members:
:undoc-members:
:show-inheritance:
topologie.models module
-----------------------
.. automodule:: topologie.models
:members:
:undoc-members:
:show-inheritance:
topologie.tests module
----------------------
.. automodule:: topologie.tests
:members:
:undoc-members:
:show-inheritance:
topologie.urls module
---------------------
.. automodule:: topologie.urls
:members:
:undoc-members:
:show-inheritance:
topologie.views module
----------------------
.. automodule:: topologie.views
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: topologie
:members:
:undoc-members:
:show-inheritance:

502
doc/source/code/users.migrations.rst Normal file
View file

@ -0,0 +1,502 @@
users.migrations package
========================
Submodules
----------
users.migrations.0001_initial module
------------------------------------
.. automodule:: users.migrations.0001_initial
:members:
:undoc-members:
:show-inheritance:
users.migrations.0002_auto_20160630_2301 module
-----------------------------------------------
.. automodule:: users.migrations.0002_auto_20160630_2301
:members:
:undoc-members:
:show-inheritance:
users.migrations.0003_listrights_rights module
----------------------------------------------
.. automodule:: users.migrations.0003_listrights_rights
:members:
:undoc-members:
:show-inheritance:
users.migrations.0004_auto_20160701_2312 module
-----------------------------------------------
.. automodule:: users.migrations.0004_auto_20160701_2312
:members:
:undoc-members:
:show-inheritance:
users.migrations.0005_auto_20160702_0006 module
-----------------------------------------------
.. automodule:: users.migrations.0005_auto_20160702_0006
:members:
:undoc-members:
:show-inheritance:
users.migrations.0006_ban module
--------------------------------
.. automodule:: users.migrations.0006_ban
:members:
:undoc-members:
:show-inheritance:
users.migrations.0007_auto_20160702_2322 module
-----------------------------------------------
.. automodule:: users.migrations.0007_auto_20160702_2322
:members:
:undoc-members:
:show-inheritance:
users.migrations.0008_user_registered module
--------------------------------------------
.. automodule:: users.migrations.0008_user_registered
:members:
:undoc-members:
:show-inheritance:
users.migrations.0009_user_room module
--------------------------------------
.. automodule:: users.migrations.0009_user_room
:members:
:undoc-members:
:show-inheritance:
users.migrations.0010_auto_20160703_1226 module
-----------------------------------------------
.. automodule:: users.migrations.0010_auto_20160703_1226
:members:
:undoc-members:
:show-inheritance:
users.migrations.0011_auto_20160703_1227 module
-----------------------------------------------
.. automodule:: users.migrations.0011_auto_20160703_1227
:members:
:undoc-members:
:show-inheritance:
users.migrations.0012_auto_20160703_1230 module
-----------------------------------------------
.. automodule:: users.migrations.0012_auto_20160703_1230
:members:
:undoc-members:
:show-inheritance:
users.migrations.0013_auto_20160704_1547 module
-----------------------------------------------
.. automodule:: users.migrations.0013_auto_20160704_1547
:members:
:undoc-members:
:show-inheritance:
users.migrations.0014_auto_20160704_1548 module
-----------------------------------------------
.. automodule:: users.migrations.0014_auto_20160704_1548
:members:
:undoc-members:
:show-inheritance:
users.migrations.0015_whitelist module
--------------------------------------
.. automodule:: users.migrations.0015_whitelist
:members:
:undoc-members:
:show-inheritance:
users.migrations.0016_auto_20160706_1220 module
-----------------------------------------------
.. automodule:: users.migrations.0016_auto_20160706_1220
:members:
:undoc-members:
:show-inheritance:
users.migrations.0017_auto_20160707_0105 module
-----------------------------------------------
.. automodule:: users.migrations.0017_auto_20160707_0105
:members:
:undoc-members:
:show-inheritance:
users.migrations.0018_auto_20160707_0115 module
-----------------------------------------------
.. automodule:: users.migrations.0018_auto_20160707_0115
:members:
:undoc-members:
:show-inheritance:
users.migrations.0019_auto_20160708_1633 module
-----------------------------------------------
.. automodule:: users.migrations.0019_auto_20160708_1633
:members:
:undoc-members:
:show-inheritance:
users.migrations.0020_request module
------------------------------------
.. automodule:: users.migrations.0020_request
:members:
:undoc-members:
:show-inheritance:
users.migrations.0021_ldapuser module
-------------------------------------
.. automodule:: users.migrations.0021_ldapuser
:members:
:undoc-members:
:show-inheritance:
users.migrations.0022_ldapuser_sambasid module
----------------------------------------------
.. automodule:: users.migrations.0022_ldapuser_sambasid
:members:
:undoc-members:
:show-inheritance:
users.migrations.0023_auto_20160724_1908 module
-----------------------------------------------
.. automodule:: users.migrations.0023_auto_20160724_1908
:members:
:undoc-members:
:show-inheritance:
users.migrations.0024_remove_ldapuser_mac_list module
-----------------------------------------------------
.. automodule:: users.migrations.0024_remove_ldapuser_mac_list
:members:
:undoc-members:
:show-inheritance:
users.migrations.0025_listshell module
--------------------------------------
.. automodule:: users.migrations.0025_listshell
:members:
:undoc-members:
:show-inheritance:
users.migrations.0026_user_shell module
---------------------------------------
.. automodule:: users.migrations.0026_user_shell
:members:
:undoc-members:
:show-inheritance:
users.migrations.0027_auto_20160726_0216 module
-----------------------------------------------
.. automodule:: users.migrations.0027_auto_20160726_0216
:members:
:undoc-members:
:show-inheritance:
users.migrations.0028_auto_20160726_0227 module
-----------------------------------------------
.. automodule:: users.migrations.0028_auto_20160726_0227
:members:
:undoc-members:
:show-inheritance:
users.migrations.0029_auto_20160726_0229 module
-----------------------------------------------
.. automodule:: users.migrations.0029_auto_20160726_0229
:members:
:undoc-members:
:show-inheritance:
users.migrations.0030_auto_20160726_0357 module
-----------------------------------------------
.. automodule:: users.migrations.0030_auto_20160726_0357
:members:
:undoc-members:
:show-inheritance:
users.migrations.0031_auto_20160726_0359 module
-----------------------------------------------
.. automodule:: users.migrations.0031_auto_20160726_0359
:members:
:undoc-members:
:show-inheritance:
users.migrations.0032_auto_20160727_2122 module
-----------------------------------------------
.. automodule:: users.migrations.0032_auto_20160727_2122
:members:
:undoc-members:
:show-inheritance:
users.migrations.0033_remove_ldapuser_loginshell module
-------------------------------------------------------
.. automodule:: users.migrations.0033_remove_ldapuser_loginshell
:members:
:undoc-members:
:show-inheritance:
users.migrations.0034_auto_20161018_0037 module
-----------------------------------------------
.. automodule:: users.migrations.0034_auto_20161018_0037
:members:
:undoc-members:
:show-inheritance:
users.migrations.0035_auto_20161018_0046 module
-----------------------------------------------
.. automodule:: users.migrations.0035_auto_20161018_0046
:members:
:undoc-members:
:show-inheritance:
users.migrations.0036_auto_20161022_2146 module
-----------------------------------------------
.. automodule:: users.migrations.0036_auto_20161022_2146
:members:
:undoc-members:
:show-inheritance:
users.migrations.0037_auto_20161028_1906 module
-----------------------------------------------
.. automodule:: users.migrations.0037_auto_20161028_1906
:members:
:undoc-members:
:show-inheritance:
users.migrations.0038_auto_20161031_0258 module
-----------------------------------------------
.. automodule:: users.migrations.0038_auto_20161031_0258
:members:
:undoc-members:
:show-inheritance:
users.migrations.0039_auto_20161119_0033 module
-----------------------------------------------
.. automodule:: users.migrations.0039_auto_20161119_0033
:members:
:undoc-members:
:show-inheritance:
users.migrations.0040_auto_20161119_1709 module
-----------------------------------------------
.. automodule:: users.migrations.0040_auto_20161119_1709
:members:
:undoc-members:
:show-inheritance:
users.migrations.0041_listright_details module
----------------------------------------------
.. automodule:: users.migrations.0041_listright_details
:members:
:undoc-members:
:show-inheritance:
users.migrations.0042_auto_20161126_2028 module
-----------------------------------------------
.. automodule:: users.migrations.0042_auto_20161126_2028
:members:
:undoc-members:
:show-inheritance:
users.migrations.0043_auto_20161224_1156 module
-----------------------------------------------
.. automodule:: users.migrations.0043_auto_20161224_1156
:members:
:undoc-members:
:show-inheritance:
users.migrations.0043_ban_state module
--------------------------------------
.. automodule:: users.migrations.0043_ban_state
:members:
:undoc-members:
:show-inheritance:
users.migrations.0044_user_ssh_public_key module
------------------------------------------------
.. automodule:: users.migrations.0044_user_ssh_public_key
:members:
:undoc-members:
:show-inheritance:
users.migrations.0045_merge module
----------------------------------
.. automodule:: users.migrations.0045_merge
:members:
:undoc-members:
:show-inheritance:
users.migrations.0046_auto_20170617_1433 module
-----------------------------------------------
.. automodule:: users.migrations.0046_auto_20170617_1433
:members:
:undoc-members:
:show-inheritance:
users.migrations.0047_auto_20170618_0156 module
-----------------------------------------------
.. automodule:: users.migrations.0047_auto_20170618_0156
:members:
:undoc-members:
:show-inheritance:
users.migrations.0048_auto_20170618_0210 module
-----------------------------------------------
.. automodule:: users.migrations.0048_auto_20170618_0210
:members:
:undoc-members:
:show-inheritance:
users.migrations.0049_auto_20170618_1424 module
-----------------------------------------------
.. automodule:: users.migrations.0049_auto_20170618_1424
:members:
:undoc-members:
:show-inheritance:
users.migrations.0050_serviceuser_comment module
------------------------------------------------
.. automodule:: users.migrations.0050_serviceuser_comment
:members:
:undoc-members:
:show-inheritance:
users.migrations.0051_user_telephone module
-------------------------------------------
.. automodule:: users.migrations.0051_user_telephone
:members:
:undoc-members:
:show-inheritance:
users.migrations.0052_ldapuser_shadowexpire module
--------------------------------------------------
.. automodule:: users.migrations.0052_ldapuser_shadowexpire
:members:
:undoc-members:
:show-inheritance:
users.migrations.0053_auto_20170626_2105 module
-----------------------------------------------
.. automodule:: users.migrations.0053_auto_20170626_2105
:members:
:undoc-members:
:show-inheritance:
users.migrations.0054_auto_20170626_2219 module
-----------------------------------------------
.. automodule:: users.migrations.0054_auto_20170626_2219
:members:
:undoc-members:
:show-inheritance:
users.migrations.0055_auto_20171003_0556 module
-----------------------------------------------
.. automodule:: users.migrations.0055_auto_20171003_0556
:members:
:undoc-members:
:show-inheritance:
users.migrations.0056_auto_20171015_2033 module
-----------------------------------------------
.. automodule:: users.migrations.0056_auto_20171015_2033
:members:
:undoc-members:
:show-inheritance:
users.migrations.0057_auto_20171023_0301 module
-----------------------------------------------
.. automodule:: users.migrations.0057_auto_20171023_0301
:members:
:undoc-members:
:show-inheritance:
users.migrations.0058_auto_20171025_0154 module
-----------------------------------------------
.. automodule:: users.migrations.0058_auto_20171025_0154
:members:
:undoc-members:
:show-inheritance:
users.migrations.0059_auto_20171025_1854 module
-----------------------------------------------
.. automodule:: users.migrations.0059_auto_20171025_1854
:members:
:undoc-members:
:show-inheritance:
users.migrations.0060_auto_20171120_0317 module
-----------------------------------------------
.. automodule:: users.migrations.0060_auto_20171120_0317
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: users.migrations
:members:
:undoc-members:
:show-inheritance:

77
doc/source/code/users.rst Normal file
View file

@ -0,0 +1,77 @@
users package
=============
Subpackages
-----------
.. toctree::
users.migrations
Submodules
----------
users.admin module
------------------
.. automodule:: users.admin
:members:
:undoc-members:
:show-inheritance:
users.forms module
------------------
.. automodule:: users.forms
:members:
:undoc-members:
:show-inheritance:
users.models module
-------------------
.. automodule:: users.models
:members:
:undoc-members:
:show-inheritance:
users.serializers module
------------------------
.. automodule:: users.serializers
:members:
:undoc-members:
:show-inheritance:
users.tests module
------------------
.. automodule:: users.tests
:members:
:undoc-members:
:show-inheritance:
users.urls module
-----------------
.. automodule:: users.urls
:members:
:undoc-members:
:show-inheritance:
users.views module
------------------
.. automodule:: users.views
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: users
:members:
:undoc-members:
:show-inheritance:

349
doc/source/conf.py Normal file
View file

@ -0,0 +1,349 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Re2o documentation build configuration file, created by
# sphinx-quickstart on Wed Dec 27 11:52:30 2017.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys
sys.path.insert(0, '/var/www/re2o')#os.path.abspath('.'))
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "re2o.settings")
import django
django.setup()
# from django.conf import settings
# settings.configure()
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The encoding of source files.
#
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = 'Re2o'
copyright = '2017, Gabriel Détraz, Goulven Kermarec, Augustin Lemesle, Maël Kervella'
author = 'Gabriel Détraz, Goulven Kermarec, Augustin Lemesle, Maël Kervella'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '1'
# The full version, including alpha/beta/rc tags.
release = '1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#
# today = ''
#
# Else, today_fmt is used as the format for a strftime call.
#
# today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = []
# The reST default role (used for this markup: `text`) to use for all
# documents.
#
# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#
# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#
# add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
# keep_warnings = False
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
#
# html_title = 'Re2o v1'
# A shorter title for the navigation bar. Default is the same as html_title.
#
# html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#
# html_logo = None
# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#
# html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#
# html_extra_path = []
# If not None, a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format.
# The empty string is equivalent to '%b %d, %Y'.
#
# html_last_updated_fmt = None
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#
# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#
# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#
# html_additional_pages = {}
# If false, no module index is generated.
#
# html_domain_indices = True
# If false, no index is generated.
#
# html_use_index = True
# If true, the index is split into individual pages for each letter.
#
# html_split_index = False
# If true, links to the reST sources are added to the pages.
#
# html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#
# html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#
# html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#
# html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None
# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
#
# html_search_language = 'en'
# A dictionary with options for the search language support, empty by default.
# 'ja' uses this config value.
# 'zh' user can custom change `jieba` dictionary path.
#
# html_search_options = {'type': 'default'}
# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#
# html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
htmlhelp_basename = 'Re2odoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'Re2o.tex', 'Re2o Documentation',
'Gabriel Détraz, Goulven Kermarec, Augustin Lemesle, Maël Kervella', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#
# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#
# latex_use_parts = False
# If true, show page references after internal links.
#
# latex_show_pagerefs = False
# If true, show URL addresses after external links.
#
# latex_show_urls = False
# Documents to append as an appendix to all manuals.
#
# latex_appendices = []
# It false, will not define \strong, \code, itleref, \crossref ... but only
# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
# packages.
#
# latex_keep_old_macro_names = True
# If false, no module index is generated.
#
# latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 're2o', 'Re2o Documentation',
[author], 1)
]
# If true, show URL addresses after external links.
#
# man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'Re2o', 'Re2o Documentation',
author, 'Re2o', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#
# texinfo_appendices = []
# If false, no module index is generated.
#
# texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#
# texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#
# texinfo_no_detailmenu = False

22
doc/source/index.rst Normal file
View file

@ -0,0 +1,22 @@
.. Re2o documentation master file, created by
sphinx-quickstart on Wed Dec 27 11:52:30 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Re2o's documentation!
================================
Contents:
.. toctree::
:maxdepth: 2
code/modules
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`