Commit 2fa37be5 authored by Samuel Debionne's avatar Samuel Debionne

Add doc scaffholding

parent ae30a4bb
Pipeline #8669 passed with stages
in 6 minutes and 12 seconds
# Algorithms
## Task graph
# -*- coding: utf-8 -*-
# Lima documentation build configuration file, created by
# sphinx-quickstart on Fri Feb 18 10:19:02 2011.
# 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.
import sys, os, subprocess, re
# 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.
# Read The Docs.
read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
# -- RunDoxygen first thing ------------------------------------------------
if read_the_docs_build:'doxygen core.dox; doxygen tasks.dox', shell=True)
# -- General configuration -----------------------------------------------------
# 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.todo', 'sphinx.ext.ifconfig',
'sphinx.ext.mathjax', 'breathe'
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
from recommonmark.parser import CommonMarkParser
source_parsers = {
'.md': CommonMarkParser,
# The suffix of source filenames.
source_suffix = ['.rst', '.md']
# The encoding of source files.
#source_encoding = 'utf-8'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'Processlib'
copyright = u'2019, Lima Team'
# 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 = re.sub('^v', '', os.popen('git describe').read().strip())
# The full version, including alpha/beta/rc tags.
release = version
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#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 documents that shouldn't be included in the build.
#unused_docs = []
# List of directories, relative to source directory, that shouldn't be searched
# for source files.
exclude_trees = []
# 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 = []
# Tell breathe about the projects
breathe_projects = { "core": ".doxygen/core/", "tasks": ".doxygen/tasks/" }
breathe_default_project = "core"
breathe_domain_by_extension = {"h" : "cpp"}
# -- Options for HTML output ---------------------------------------------------
# only import and set the theme if we're building docs locally
if not read_the_docs_build:
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# otherwise, uses their theme by default, so no need to specify it
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
#html_theme = 'default'
# 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. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# 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 = 'lima-logo-2-40perc.png'
# The name of an image file (within the static path) to use as 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']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# 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_use_modindex = 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, 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 = ''
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = ''
# Output file base name for HTML help builder.
htmlhelp_basename = 'Processlib'
# -- Options for LaTeX output --------------------------------------------------
# The paper size ('letter' or 'a4').
latex_paper_size = 'a4'
# The font size ('10pt', '11pt' or '12pt').
latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'Processlib.tex', u'Processlib Documentation',
u'Lima Team', 'manual'),
# The name of an image file (relative to this directory) to place at the top of
# the title page.
latex_logo = 'lima-logo-3.png'
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_use_modindex = True
This source diff could not be displayed because it is too large. You can view the blob instead.
# Core
## Data
Unfortunately very limited documentation is available from the source but that should improve over time.
.. doxygenclass:: PoolThreadMgr
:project: core
Processlib : Library for Image Processing
Processlib is a companion library of LImA (**L** ibrary for **Im** age **A** cquisition) project that provides image processing.
Processlib is a C++ library but the library also comes with a Python_ binding.
We provide Conda binary package for Windows and Linux for some cameras. Check out our `Conda channel <>`_.
If you want to get in touch with the LIMA community, please send an email to You may also want to subscribe to our mailing list by sending a message to ` <>`_ with ``subscribe lima`` as subject.
.. toctree::
:maxdepth: 1
:caption: User Documentation
.. toctree::
:maxdepth: 1
:caption: Reference Documentation
.. _Python:
.. _Conda:
REM Command file for Sphinx documentation
set SPHINXBUILD=sphinx-build
if NOT "%PAPER%" == "" (
if "%1" == "" goto help
if "%1" == "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. 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. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
echo. changes to make an overview over all changed/added/deprecated items
echo. linkcheck to check all external links for integrity
echo. doctest to run all doctests embedded in the documentation if enabled
goto end
if "%1" == "clean" (
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
del /q /s %BUILDDIR%\*
goto end
if "%1" == "html" (
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
goto end
if "%1" == "dirhtml" (
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
goto end
if "%1" == "pickle" (
echo.Build finished; now you can process the pickle files.
goto end
if "%1" == "json" (
echo.Build finished; now you can process the JSON files.
goto end
if "%1" == "htmlhelp" (
echo.Build finished; now you can run HTML Help Workshop with the ^
.hhp project file in %BUILDDIR%/htmlhelp.
goto end
if "%1" == "qthelp" (
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Lima.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Lima.ghc
goto end
if "%1" == "latex" (
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
goto end
if "%1" == "changes" (
echo.The overview file is in %BUILDDIR%/changes.
goto end
if "%1" == "linkcheck" (
echo.Link check complete; look for any errors in the above output ^
or in %BUILDDIR%/linkcheck/output.txt.
goto end
if "%1" == "doctest" (
echo.Testing of doctests in the sources finished, look at the ^
results in %BUILDDIR%/doctest/output.txt.
goto end
Python API
Most of the previous sections about the user interface routines applies to the Python binding. Naturally, some specifics concerning Python come into play.
This documentation is very much a work in progress. Stay tuned!
This source diff could not be displayed because it is too large. You can view the blob instead.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment