[libcamera-devel,v2] Documentation: Introduce sphinx documentation

10 diff mbox series

Utilise sphinx-build to generate documentation in HTML form, and
populate with some initial content.

An initial conf.py is generated from sphinx-quickstart and answering
initial questions.

Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

---
v2:
 - Fix spelling in hacking.rst
 - Remove autogenerated comments at index.rst
 - Fix whitespaces
 - Remove autogenerated Makefile
 - Fix typos and grammar

 Documentation/conf.py     | 173 ++++++++++++++++++++++++++++++++++++++
 Documentation/hacking.rst |  42 +++++++++
 Documentation/index.rst   |  30 +++++++
 Documentation/meson.build |  20 +++++
 meson.build               |   6 ++
 5 files changed, 271 insertions(+)
 create mode 100644 Documentation/conf.py
 create mode 100644 Documentation/hacking.rst
 create mode 100644 Documentation/index.rst
 create mode 100644 Documentation/meson.build

Hi Kieran,

Thanks for your patch.

On 2018-11-22 16:58:52 +0000, Kieran Bingham wrote:
> Utilise sphinx-build to generate documentation in HTML form, and
> populate with some initial content.
> 
> An initial conf.py is generated from sphinx-quickstart and answering
> initial questions.
> 
> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
> 
> ---
> v2:
>  - Fix spelling in hacking.rst
>  - Remove autogenerated comments at index.rst
>  - Fix whitespaces
>  - Remove autogenerated Makefile
>  - Fix typos and grammar
> 
>  Documentation/conf.py     | 173 ++++++++++++++++++++++++++++++++++++++
>  Documentation/hacking.rst |  42 +++++++++
>  Documentation/index.rst   |  30 +++++++
>  Documentation/meson.build |  20 +++++
>  meson.build               |   6 ++
>  5 files changed, 271 insertions(+)
>  create mode 100644 Documentation/conf.py
>  create mode 100644 Documentation/hacking.rst
>  create mode 100644 Documentation/index.rst
>  create mode 100644 Documentation/meson.build
> 
> diff --git a/Documentation/conf.py b/Documentation/conf.py
> new file mode 100644
> index 000000000000..70d4e72c6902
> --- /dev/null
> +++ b/Documentation/conf.py
> @@ -0,0 +1,173 @@
> +# -*- coding: utf-8 -*-
> +#
> +# Configuration file for the Sphinx documentation builder.
> +#
> +# This file does only contain a selection of the most common options. For a
> +# full list see the documentation:
> +# http://www.sphinx-doc.org/en/master/config
> +
> +# -- Path setup --------------------------------------------------------------
> +
> +# 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, os.path.abspath('.'))
> +
> +
> +# -- Project information -----------------------------------------------------
> +
> +project = 'LibCamera'
> +copyright = '2018, Kieran Bingham, Jacopo Mondi, Laurent Pinchart, Niklas Soderlund'
> +author = 'Kieran Bingham, Jacopo Mondi, Laurent Pinchart, Niklas Soderlund'

My pretty döts seems to me missing :-)

> +
> +# The short X.Y version
> +version = ''
> +# The full version, including alpha/beta/rc tags
> +release = '0.1'
> +
> +
> +# -- 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 = [
> +]
> +
> +# 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 master toctree document.
> +master_doc = 'index'
> +
> +# 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
> +
> +# List of patterns, relative to source directory, that match files and
> +# directories to ignore when looking for source files.
> +# This pattern also affects html_static_path and html_extra_path.
> +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
> +
> +# The name of the Pygments (syntax highlighting) style to use.
> +pygments_style = None
> +
> +
> +# -- 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 = 'alabaster'
> +
> +# 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 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']
> +
> +# Custom sidebar templates, must be a dictionary that maps document names
> +# to template names.
> +#
> +# The default sidebars (for documents that don't match any pattern) are
> +# defined by theme itself.  Builtin themes are using these templates by
> +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
> +# 'searchbox.html']``.
> +#
> +# html_sidebars = {}
> +
> +
> +# -- Options for HTMLHelp output ---------------------------------------------
> +
> +# Output file base name for HTML help builder.
> +htmlhelp_basename = 'LibCameradoc'
> +
> +
> +# -- 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, 'LibCamera.tex', 'LibCamera Documentation',
> +     'Kieran Bingham, Jacopo Mondi, Laurent Pinchart, Niklas Soderlund', 'manual'),

:-)

> +]
> +
> +
> +# -- 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, 'libcamera', 'LibCamera Documentation',
> +     [author], 1)
> +]
> +
> +
> +# -- 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, 'LibCamera', 'LibCamera Documentation',
> +     author, 'LibCamera', 'One line description of project.',
> +     'Miscellaneous'),
> +]
> +
> +
> +# -- Options for Epub output -------------------------------------------------
> +
> +# Bibliographic Dublin Core info.
> +epub_title = project
> +
> +# The unique identifier of the text. This can be a ISBN number
> +# or the project homepage.
> +#
> +# epub_identifier = ''
> +
> +# A unique identification for the text.
> +#
> +# epub_uid = ''
> +
> +# A list of files that should not be packed into the epub file.
> +epub_exclude_files = ['search.html']
> \ No newline at end of file
> diff --git a/Documentation/hacking.rst b/Documentation/hacking.rst
> new file mode 100644
> index 000000000000..2dbee7f2b88d
> --- /dev/null
> +++ b/Documentation/hacking.rst
> @@ -0,0 +1,42 @@
> +Hacking and Development
> +=======================
> +
> +libcamera is developed as a free software project and welcomes contributors.
> +Whether you would like to help with coding, documentation, testing, proposing
> +new features, or just discussing the project with the community, you can join
> +our official public communication channels, or simply check out the code.
> +Mailing List

This seems odd, should not the 'Mailing List' also have a line of - to 
make it a subsection?

With these issues addressed feel free to add

Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>

> +
> +We use a public mailing list as our main means of communication. You can find
> +subscription information and the messages archive on the libcamera-devel list
> +information page.
> +
> +IRC Channel
> +-----------
> +
> +For informal and real time discussions, our IRC channel on Freenode is open to
> +the public. Point your IRC client to #libcamera to say hello, or use the `WebChat`_.
> +
> +.. _WebChat: https://webchat.freenode.net/?channels=%23libcamera&uio=d4
> +
> +Source Code
> +-----------
> +
> +libcamera is in early stages of development, and no releases are available yet.
> +The source code is available from the project's git tree, hosted by LinuxTV.
> +
> +  $ git clone git://linuxtv.org/libcamera.git
> +
> +Documentation
> +-------------
> +
> +Project documentation is created using `Sphinx`_.  Source level documentation
> +is currently planned to utilise Doxygen integration.  Please use this in your
> +development.
> +
> +Sphinx integration with Doxygen will be with either `Breathe`_ or `Exhale`_
> +depending upon which system works best
> +
> +.. _Sphinx: http://www.sphinx-doc.org
> +.. _Breathe: https://breathe.readthedocs.io/en/latest/
> +.. _Exhale: https://exhale.readthedocs.io/en/latest/
> diff --git a/Documentation/index.rst b/Documentation/index.rst
> new file mode 100644
> index 000000000000..962192ec8ee8
> --- /dev/null
> +++ b/Documentation/index.rst
> @@ -0,0 +1,30 @@
> +LibCamera abstraction library
> +=============================
> +
> +Cameras are complex devices that need heavy hardware image processing
> +operations. Control of the processing is based on advanced algorithms that must
> +run on a programmable processor. This has traditionally been implemented in a
> +dedicated MCU in the camera, but in embedded devices algorithms have been moved
> +to the main CPU to save cost. Blurring the boundary between camera devices and
> +Linux often left the user with no other option than a vendor-specific
> +closed-source solution.
> +
> +To address this problem the Linux media community has very recently started
> +collaboration with the industry to develop a camera stack that will be
> +open-source-friendly while still protecting vendor core IP. libcamera was born
> +out of that collaboration and will offer modern camera support to Linux-based
> +systems, including traditional Linux distributions, ChromeOS and Android.
> +
> +
> +.. toctree::
> +   :maxdepth: 2
> +   :caption: Contents:
> +
> +   hacking
> +
> +
> +Indices and tables
> +==================
> +
> +* :ref:`genindex`
> +* :ref:`search`
> diff --git a/Documentation/meson.build b/Documentation/meson.build
> new file mode 100644
> index 000000000000..5ab04479d3fb
> --- /dev/null
> +++ b/Documentation/meson.build
> @@ -0,0 +1,20 @@
> +sphinx = find_program('sphinx-build-3', required: false)
> +if not sphinx.found()
> +    sphinx = find_program('sphinx-build', required: false)
> +endif
> +
> +if sphinx.found()
> +    docs_sources = [
> +	'hacking.rst',
> +	'index.rst',
> +    ]
> +
> +    custom_target('en user documentation',
> +		  command: [sphinx, '-W', '-b', 'html', meson.current_source_dir(), '@OUTPUT@'],
> +		  input: docs_sources,
> +		  output: 'en',
> +		  build_by_default: true)
> +
> +    install_subdir(meson.current_build_dir() + '/en',
> +		  install_dir: 'share/doc/libcamera-@0@/user'.format(api_version))
> +endif
> diff --git a/meson.build b/meson.build
> index 4b3d528c8932..434aa557b8a1 100644
> --- a/meson.build
> +++ b/meson.build
> @@ -2,8 +2,14 @@ project('libcamera - supporting complex camera pipelines', 'c', 'cpp',
>    version : '0.1',
>    license : 'LGPL 2.1+')
>  
> +# TODO: Extract this from project.version.
> +#	Ideally the version at Documentation/conf.py should be
> +#	generated from this too.
> +api_version = '0.1'
> +
>  inc = include_directories('include')
>  
> +subdir('Documentation')
>  subdir('lib')
>  subdir('test')
>  subdir('utils')
> -- 
> 2.17.1
> 
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel@lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel

Hi Niklas,

Thank you for the review,

On 23/11/2018 13:19, Niklas Söderlund wrote:
> Hi Kieran,
> 
> Thanks for your patch.
> 
> On 2018-11-22 16:58:52 +0000, Kieran Bingham wrote:
>> Utilise sphinx-build to generate documentation in HTML form, and
>> populate with some initial content.
>>
>> An initial conf.py is generated from sphinx-quickstart and answering
>> initial questions.
>>
>> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
>>
>> ---
>> v2:
>>  - Fix spelling in hacking.rst
>>  - Remove autogenerated comments at index.rst
>>  - Fix whitespaces
>>  - Remove autogenerated Makefile
>>  - Fix typos and grammar
>>
>>  Documentation/conf.py     | 173 ++++++++++++++++++++++++++++++++++++++
>>  Documentation/hacking.rst |  42 +++++++++
>>  Documentation/index.rst   |  30 +++++++
>>  Documentation/meson.build |  20 +++++
>>  meson.build               |   6 ++
>>  5 files changed, 271 insertions(+)
>>  create mode 100644 Documentation/conf.py
>>  create mode 100644 Documentation/hacking.rst
>>  create mode 100644 Documentation/index.rst
>>  create mode 100644 Documentation/meson.build
>>
>> diff --git a/Documentation/conf.py b/Documentation/conf.py
>> new file mode 100644
>> index 000000000000..70d4e72c6902
>> --- /dev/null
>> +++ b/Documentation/conf.py
>> @@ -0,0 +1,173 @@
>> +# -*- coding: utf-8 -*-
>> +#
>> +# Configuration file for the Sphinx documentation builder.
>> +#
>> +# This file does only contain a selection of the most common options. For a
>> +# full list see the documentation:
>> +# http://www.sphinx-doc.org/en/master/config
>> +
>> +# -- Path setup --------------------------------------------------------------
>> +
>> +# 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, os.path.abspath('.'))
>> +
>> +
>> +# -- Project information -----------------------------------------------------
>> +
>> +project = 'LibCamera'
>> +copyright = '2018, Kieran Bingham, Jacopo Mondi, Laurent Pinchart, Niklas Soderlund'
>> +author = 'Kieran Bingham, Jacopo Mondi, Laurent Pinchart, Niklas Soderlund'
> 
> My pretty döts seems to me missing :-)

I have no idea how to generate those on my keyboard...

Fortunately - you've now given me a character I can copy and paste.
 (yes, of course it was already in my e-mail client)

Perhaps I was giving you a chance to increase your patch count with a
fixup patch later ;-)

> 
>> +
>> +# The short X.Y version
>> +version = ''
>> +# The full version, including alpha/beta/rc tags
>> +release = '0.1'
>> +
>> +
>> +# -- 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 = [
>> +]
>> +
>> +# 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 master toctree document.
>> +master_doc = 'index'
>> +
>> +# 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
>> +
>> +# List of patterns, relative to source directory, that match files and
>> +# directories to ignore when looking for source files.
>> +# This pattern also affects html_static_path and html_extra_path.
>> +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
>> +
>> +# The name of the Pygments (syntax highlighting) style to use.
>> +pygments_style = None
>> +
>> +
>> +# -- 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 = 'alabaster'
>> +
>> +# 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 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']
>> +
>> +# Custom sidebar templates, must be a dictionary that maps document names
>> +# to template names.
>> +#
>> +# The default sidebars (for documents that don't match any pattern) are
>> +# defined by theme itself.  Builtin themes are using these templates by
>> +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
>> +# 'searchbox.html']``.
>> +#
>> +# html_sidebars = {}
>> +
>> +
>> +# -- Options for HTMLHelp output ---------------------------------------------
>> +
>> +# Output file base name for HTML help builder.
>> +htmlhelp_basename = 'LibCameradoc'
>> +
>> +
>> +# -- 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, 'LibCamera.tex', 'LibCamera Documentation',
>> +     'Kieran Bingham, Jacopo Mondi, Laurent Pinchart, Niklas Soderlund', 'manual'),
> 
> :-)
> 

I'll update here as well.


>> +]
>> +
>> +
>> +# -- 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, 'libcamera', 'LibCamera Documentation',
>> +     [author], 1)
>> +]
>> +
>> +
>> +# -- 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, 'LibCamera', 'LibCamera Documentation',
>> +     author, 'LibCamera', 'One line description of project.',
>> +     'Miscellaneous'),
>> +]
>> +
>> +
>> +# -- Options for Epub output -------------------------------------------------
>> +
>> +# Bibliographic Dublin Core info.
>> +epub_title = project
>> +
>> +# The unique identifier of the text. This can be a ISBN number
>> +# or the project homepage.
>> +#
>> +# epub_identifier = ''
>> +
>> +# A unique identification for the text.
>> +#
>> +# epub_uid = ''
>> +
>> +# A list of files that should not be packed into the epub file.
>> +epub_exclude_files = ['search.html']
>> \ No newline at end of file
>> diff --git a/Documentation/hacking.rst b/Documentation/hacking.rst
>> new file mode 100644
>> index 000000000000..2dbee7f2b88d
>> --- /dev/null
>> +++ b/Documentation/hacking.rst
>> @@ -0,0 +1,42 @@
>> +Hacking and Development
>> +=======================
>> +
>> +libcamera is developed as a free software project and welcomes contributors.
>> +Whether you would like to help with coding, documentation, testing, proposing
>> +new features, or just discussing the project with the community, you can join
>> +our official public communication channels, or simply check out the code.
>> +Mailing List
> 
> This seems odd, should not the 'Mailing List' also have a line of - to 
> make it a subsection?


Ah yes, thank you I had missed that. This was just a copy paste from the
website.

> 
> With these issues addressed feel free to add
> 
> Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>

I'll take this and commit to master :)


> 
>> +
>> +We use a public mailing list as our main means of communication. You can find
>> +subscription information and the messages archive on the libcamera-devel list
>> +information page.

It might help if I add a link to the libcamera-devel list page here too :)


>> +
>> +IRC Channel
>> +-----------
>> +
>> +For informal and real time discussions, our IRC channel on Freenode is open to
>> +the public. Point your IRC client to #libcamera to say hello, or use the `WebChat`_.
>> +
>> +.. _WebChat: https://webchat.freenode.net/?channels=%23libcamera&uio=d4
>> +
>> +Source Code
>> +-----------
>> +
>> +libcamera is in early stages of development, and no releases are available yet.
>> +The source code is available from the project's git tree, hosted by LinuxTV.
>> +
>> +  $ git clone git://linuxtv.org/libcamera.git
>> +
>> +Documentation
>> +-------------
>> +
>> +Project documentation is created using `Sphinx`_.  Source level documentation
>> +is currently planned to utilise Doxygen integration.  Please use this in your
>> +development.
>> +
>> +Sphinx integration with Doxygen will be with either `Breathe`_ or `Exhale`_
>> +depending upon which system works best
>> +
>> +.. _Sphinx: http://www.sphinx-doc.org
>> +.. _Breathe: https://breathe.readthedocs.io/en/latest/
>> +.. _Exhale: https://exhale.readthedocs.io/en/latest/
>> diff --git a/Documentation/index.rst b/Documentation/index.rst
>> new file mode 100644
>> index 000000000000..962192ec8ee8
>> --- /dev/null
>> +++ b/Documentation/index.rst
>> @@ -0,0 +1,30 @@
>> +LibCamera abstraction library
>> +=============================
>> +
>> +Cameras are complex devices that need heavy hardware image processing
>> +operations. Control of the processing is based on advanced algorithms that must
>> +run on a programmable processor. This has traditionally been implemented in a
>> +dedicated MCU in the camera, but in embedded devices algorithms have been moved
>> +to the main CPU to save cost. Blurring the boundary between camera devices and
>> +Linux often left the user with no other option than a vendor-specific
>> +closed-source solution.
>> +
>> +To address this problem the Linux media community has very recently started
>> +collaboration with the industry to develop a camera stack that will be
>> +open-source-friendly while still protecting vendor core IP. libcamera was born
>> +out of that collaboration and will offer modern camera support to Linux-based
>> +systems, including traditional Linux distributions, ChromeOS and Android.
>> +
>> +
>> +.. toctree::
>> +   :maxdepth: 2
>> +   :caption: Contents:
>> +
>> +   hacking
>> +
>> +
>> +Indices and tables
>> +==================
>> +
>> +* :ref:`genindex`
>> +* :ref:`search`
>> diff --git a/Documentation/meson.build b/Documentation/meson.build
>> new file mode 100644
>> index 000000000000..5ab04479d3fb
>> --- /dev/null
>> +++ b/Documentation/meson.build
>> @@ -0,0 +1,20 @@
>> +sphinx = find_program('sphinx-build-3', required: false)
>> +if not sphinx.found()
>> +    sphinx = find_program('sphinx-build', required: false)
>> +endif
>> +
>> +if sphinx.found()
>> +    docs_sources = [
>> +	'hacking.rst',
>> +	'index.rst',
>> +    ]
>> +
>> +    custom_target('en user documentation',
>> +		  command: [sphinx, '-W', '-b', 'html', meson.current_source_dir(), '@OUTPUT@'],
>> +		  input: docs_sources,
>> +		  output: 'en',
>> +		  build_by_default: true)
>> +
>> +    install_subdir(meson.current_build_dir() + '/en',
>> +		  install_dir: 'share/doc/libcamera-@0@/user'.format(api_version))
>> +endif
>> diff --git a/meson.build b/meson.build
>> index 4b3d528c8932..434aa557b8a1 100644
>> --- a/meson.build
>> +++ b/meson.build
>> @@ -2,8 +2,14 @@ project('libcamera - supporting complex camera pipelines', 'c', 'cpp',
>>    version : '0.1',
>>    license : 'LGPL 2.1+')
>>  
>> +# TODO: Extract this from project.version.
>> +#	Ideally the version at Documentation/conf.py should be
>> +#	generated from this too.
>> +api_version = '0.1'
>> +
>>  inc = include_directories('include')
>>  
>> +subdir('Documentation')
>>  subdir('lib')
>>  subdir('test')
>>  subdir('utils')
>> -- 
>> 2.17.1
>>
>> _______________________________________________
>> libcamera-devel mailing list
>> libcamera-devel@lists.libcamera.org
>> https://lists.libcamera.org/listinfo/libcamera-devel
>

Hi Kieran,

Thank you for the patch.

On Friday, 23 November 2018 16:12:54 EET Kieran Bingham wrote:
> On 23/11/2018 13:19, Niklas Söderlund wrote:
> > On 2018-11-22 16:58:52 +0000, Kieran Bingham wrote:
> >> Utilise sphinx-build to generate documentation in HTML form, and
> >> populate with some initial content.
> >> 
> >> An initial conf.py is generated from sphinx-quickstart and answering
> >> initial questions.
> >> 
> >> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
> >> 
> >> ---
> >> 
> >> v2:
> >>  - Fix spelling in hacking.rst
> >>  - Remove autogenerated comments at index.rst
> >>  - Fix whitespaces
> >>  - Remove autogenerated Makefile
> >>  - Fix typos and grammar
> >>  
> >>  Documentation/conf.py     | 173 ++++++++++++++++++++++++++++++++++++++
> >>  Documentation/hacking.rst |  42 +++++++++
> >>  Documentation/index.rst   |  30 +++++++
> >>  Documentation/meson.build |  20 +++++
> >>  meson.build               |   6 ++
> >>  5 files changed, 271 insertions(+)
> >>  create mode 100644 Documentation/conf.py
> >>  create mode 100644 Documentation/hacking.rst
> >>  create mode 100644 Documentation/index.rst
> >>  create mode 100644 Documentation/meson.build
> >> 
> >> diff --git a/Documentation/conf.py b/Documentation/conf.py
> >> new file mode 100644
> >> index 000000000000..70d4e72c6902
> >> --- /dev/null
> >> +++ b/Documentation/conf.py
> >> @@ -0,0 +1,173 @@
> >> +# -*- coding: utf-8 -*-
> >> +#
> >> +# Configuration file for the Sphinx documentation builder.
> >> +#
> >> +# This file does only contain a selection of the most common options.
> >> For a
> >> +# full list see the documentation:
> >> +# http://www.sphinx-doc.org/en/master/config
> >> +
> >> +# -- Path setup --------------------------------------------------------
> >> +
> >> +# 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, os.path.abspath('.'))

Should we remove the commented out options (and sections) ?

> >> +# -- Project information -----------------------------------------------
> >> +
> >> +project = 'LibCamera'

Nitpicking, the project is called "libcamera" throughout the existing 
documentation.

> >> +copyright = '2018, Kieran Bingham, Jacopo Mondi, Laurent Pinchart,
> >> Niklas Soderlund' +author = 'Kieran Bingham, Jacopo Mondi, Laurent
> >> Pinchart, Niklas Soderlund'
> > 
> > My pretty döts seems to me missing :-)
> 
> I have no idea how to generate those on my keyboard...

Compose, u, "

"," means "followed by", and the compose key is specific to your system (I've 
mapped it to AltGr+Win here).

> Fortunately - you've now given me a character I can copy and paste.
>  (yes, of course it was already in my e-mail client)
> 
> Perhaps I was giving you a chance to increase your patch count with a
> fixup patch later ;-)
> 
> >> +
> >> +# The short X.Y version
> >> +version = ''
> >> +# The full version, including alpha/beta/rc tags
> >> +release = '0.1'
> >> +
> >> +
> >> +# -- 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 = [
> >> +]
> >> +
> >> +# Add any paths that contain templates here, relative to this directory.
> >> +templates_path = ['_templates']

Do we have 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 master toctree document.
> >> +master_doc = 'index'
> >> +
> >> +# 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
> >> +
> >> +# List of patterns, relative to source directory, that match files and
> >> +# directories to ignore when looking for source files.
> >> +# This pattern also affects html_static_path and html_extra_path.
> >> +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
> >> +
> >> +# The name of the Pygments (syntax highlighting) style to use.
> >> +pygments_style = None
> >> +
> >> +
> >> +# -- 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 = 'alabaster'

Exercise for the reader : develop a theme matching http://www.libcamera.org.

> >> +# 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 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']
> >> +
> >> +# Custom sidebar templates, must be a dictionary that maps document
> >> names
> >> +# to template names.
> >> +#
> >> +# The default sidebars (for documents that don't match any pattern) are
> >> +# defined by theme itself.  Builtin themes are using these templates by
> >> +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
> >> +# 'searchbox.html']``.
> >> +#
> >> +# html_sidebars = {}
> >> +
> >> +
> >> +# -- Options for HTMLHelp output ---------------------------------------
> >> +
> >> +# Output file base name for HTML help builder.
> >> +htmlhelp_basename = 'LibCameradoc'
> >> +
> >> +
> >> +# -- 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, 'LibCamera.tex', 'LibCamera Documentation',
> >> +     'Kieran Bingham, Jacopo Mondi, Laurent Pinchart, Niklas Soderlund',
> >> 'manual'),
> > 
> > :-)
> 
> I'll update here as well.
> 
> >> +]
> >> +
> >> +
> >> +# -- 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, 'libcamera', 'LibCamera Documentation',
> >> +     [author], 1)
> >> +]
> >> +
> >> +
> >> +# -- 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, 'LibCamera', 'LibCamera Documentation',
> >> +     author, 'LibCamera', 'One line description of project.',
> >> +     'Miscellaneous'),
> >> +]
> >> +
> >> +
> >> +# -- Options for Epub output
> >> ------------------------------------------------- +
> >> +# Bibliographic Dublin Core info.
> >> +epub_title = project
> >> +
> >> +# The unique identifier of the text. This can be a ISBN number
> >> +# or the project homepage.
> >> +#
> >> +# epub_identifier = ''
> >> +
> >> +# A unique identification for the text.
> >> +#
> >> +# epub_uid = ''
> >> +
> >> +# A list of files that should not be packed into the epub file.
> >> +epub_exclude_files = ['search.html']

As we don't use latex, man pages, texinfo and epub, should we remove those 
sections for now ?

> >> \ No newline at end of file

No newline at end of file ?

> >> diff --git a/Documentation/hacking.rst b/Documentation/hacking.rst
> >> new file mode 100644
> >> index 000000000000..2dbee7f2b88d
> >> --- /dev/null
> >> +++ b/Documentation/hacking.rst

The website currently stores the information below in a "Contribute" section. 
I think that name is a bit more positive than "hacking" and would prefer 
retaining it.

> >> @@ -0,0 +1,42 @@
> >> +Hacking and Development

Same here.

> >> +=======================
> >> +
> >> +libcamera is developed as a free software project and welcomes
> >> contributors.
> >> +Whether you would like to help with coding, documentation, testing,
> >> proposing
> >> +new features, or just discussing the project with the community, you can
> >> join
> >> +our official public communication channels, or simply check out the
> >> code.
> >> +Mailing List
> > 
> > This seems odd, should not the 'Mailing List' also have a line of - to
> > make it a subsection?
> 
> Ah yes, thank you I had missed that. This was just a copy paste from the
> website.
> 
> > With these issues addressed feel free to add
> > 
> > Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
> 
> I'll take this and commit to master :)
> 
> >> +
> >> +We use a public mailing list as our main means of communication. You can
> >> find
> >> +subscription information and the messages archive on the libcamera-devel
> >> list
> >> +information page.
> 
> It might help if I add a link to the libcamera-devel list page here too :)

Agreed.

> >> +
> >> +IRC Channel
> >> +-----------
> >> +
> >> +For informal and real time discussions, our IRC channel on Freenode is
> >> open to
> >> +the public. Point your IRC client to #libcamera to say hello,
> >> or use the `WebChat`_.
> >> +
> >> +.. _WebChat: https://webchat.freenode.net/?channels=%23libcamera&uio=d4
> >> +
> >> +Source Code
> >> +-----------
> >> +
> >> +libcamera is in early stages of development, and no releases are
> >> available yet.
> >> +The source code is available from the project's git tree, hosted by
> >> LinuxTV.
> >> +
> >> +  $ git clone git://linuxtv.org/libcamera.git
> >> +
> >> +Documentation
> >> +-------------
> >> +
> >> +Project documentation is created using `Sphinx`_.  Source level
> >> documentation
> >> +is currently planned to utilise Doxygen integration. Please use this in
> >> your
> >> +development.
> >> +
> >> +Sphinx integration with Doxygen will be with either `Breathe`_ or
> >> `Exhale`_
> >> +depending upon which system works best
> >> +
> >> +.. _Sphinx: http://www.sphinx-doc.org
> >> +.. _Breathe: https://breathe.readthedocs.io/en/latest/
> >> +.. _Exhale: https://exhale.readthedocs.io/en/latest/
> >> diff --git a/Documentation/index.rst b/Documentation/index.rst
> >> new file mode 100644
> >> index 000000000000..962192ec8ee8
> >> --- /dev/null
> >> +++ b/Documentation/index.rst
> >> @@ -0,0 +1,30 @@
> >> +LibCamera abstraction library

Similarly here, you should write "libcamera". "libcamera library" seems a bit 
redundant to me. Other options could be "Linux Camera Library", "Linux Camera 
Support Library", "Linux Camera Framework", "Linux Camera Framework Library" 
(possibly without the "Linux" prefix, even though the project targets Linux 
only).

> >> +=============================
> >> +
> >> +Cameras are complex devices that need heavy hardware image processing
> >> +operations. Control of the processing is based on advanced algorithms
> >> that must +run on a programmable processor. This has traditionally been
> >> implemented in a +dedicated MCU in the camera, but in embedded devices
> >> algorithms have been moved +to the main CPU to save cost. Blurring the
> >> boundary between camera devices and +Linux often left the user with no
> >> other option than a vendor-specific +closed-source solution.
> >> +
> >> +To address this problem the Linux media community has very recently
> >> started +collaboration with the industry to develop a camera stack that
> >> will be +open-source-friendly while still protecting vendor core IP.
> >> libcamera was born +out of that collaboration and will offer modern
> >> camera support to Linux-based +systems, including traditional Linux
> >> distributions, ChromeOS and Android. +
> >> +
> >> +.. toctree::
> >> +   :maxdepth: 2
> >> +   :caption: Contents:
> >> +
> >> +   hacking
> >> +
> >> +
> >> +Indices and tables
> >> +==================
> >> +
> >> +* :ref:`genindex`
> >> +* :ref:`search`
> >> diff --git a/Documentation/meson.build b/Documentation/meson.build
> >> new file mode 100644
> >> index 000000000000..5ab04479d3fb
> >> --- /dev/null
> >> +++ b/Documentation/meson.build
> >> @@ -0,0 +1,20 @@
> >> +sphinx = find_program('sphinx-build-3', required: false)
> >> +if not sphinx.found()
> >> +    sphinx = find_program('sphinx-build', required: false)
> >> +endif
> >> +
> >> +if sphinx.found()
> >> +    docs_sources = [
> >> +	'hacking.rst',
> >> +	'index.rst',
> >> +    ]
> >> +
> >> +    custom_target('en user documentation',

What does this stand for ? English user documentation ? End user documentation 
?

> >> +		  command: [sphinx, '-W', '-b', 'html', meson.current_source_dir(),
> >> '@OUTPUT@'],
> >> +		  input: docs_sources,
> >> +		  output: 'en',
> >> +		  build_by_default: true)
> >> +
> >> +    install_subdir(meson.current_build_dir() + '/en',
> >> +		  install_dir: 'share/doc/libcamera-@0@/user'.format(api_version))

Why the user/ directory ?

> >> +endif

[snip]

Hi Laurent,

On 23/11/2018 15:25, Laurent Pinchart wrote:
> Hi Kieran,
> 
> Thank you for the patch.
> 
> On Friday, 23 November 2018 16:12:54 EET Kieran Bingham wrote:
>> On 23/11/2018 13:19, Niklas Söderlund wrote:
>>> On 2018-11-22 16:58:52 +0000, Kieran Bingham wrote:
>>>> Utilise sphinx-build to generate documentation in HTML form, and
>>>> populate with some initial content.
>>>>
>>>> An initial conf.py is generated from sphinx-quickstart and answering
>>>> initial questions.
>>>>
>>>> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
>>>>
>>>> ---
>>>>
>>>> v2:
>>>>  - Fix spelling in hacking.rst
>>>>  - Remove autogenerated comments at index.rst
>>>>  - Fix whitespaces
>>>>  - Remove autogenerated Makefile
>>>>  - Fix typos and grammar
>>>>  
>>>>  Documentation/conf.py     | 173 ++++++++++++++++++++++++++++++++++++++
>>>>  Documentation/hacking.rst |  42 +++++++++
>>>>  Documentation/index.rst   |  30 +++++++
>>>>  Documentation/meson.build |  20 +++++
>>>>  meson.build               |   6 ++
>>>>  5 files changed, 271 insertions(+)
>>>>  create mode 100644 Documentation/conf.py
>>>>  create mode 100644 Documentation/hacking.rst
>>>>  create mode 100644 Documentation/index.rst
>>>>  create mode 100644 Documentation/meson.build
>>>>
>>>> diff --git a/Documentation/conf.py b/Documentation/conf.py
>>>> new file mode 100644
>>>> index 000000000000..70d4e72c6902
>>>> --- /dev/null
>>>> +++ b/Documentation/conf.py
>>>> @@ -0,0 +1,173 @@
>>>> +# -*- coding: utf-8 -*-
>>>> +#
>>>> +# Configuration file for the Sphinx documentation builder.
>>>> +#
>>>> +# This file does only contain a selection of the most common options.
>>>> For a
>>>> +# full list see the documentation:
>>>> +# http://www.sphinx-doc.org/en/master/config
>>>> +
>>>> +# -- Path setup --------------------------------------------------------
>>>> +
>>>> +# 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, os.path.abspath('.'))
> 
> Should we remove the commented out options (and sections) ?

Personally - I would say no.

(I fairly intentionally left the auto-generated file as it was generated)

This is essentially the closest (proximity) documentation for modifying
conf.py.


>>>> +# -- Project information -----------------------------------------------
>>>> +
>>>> +project = 'LibCamera'
> 
> Nitpicking, the project is called "libcamera" throughout the existing 
> documentation.

Ah yes, I'll correct it.


>>>> +copyright = '2018, Kieran Bingham, Jacopo Mondi, Laurent Pinchart,
>>>> Niklas Soderlund' +author = 'Kieran Bingham, Jacopo Mondi, Laurent
>>>> Pinchart, Niklas Soderlund'
>>>
>>> My pretty döts seems to me missing :-)
>>
>> I have no idea how to generate those on my keyboard...
> 
> Compose, u, "

↓" "↓²ø² nope

ö - Aha - got it.


> 
> "," means "followed by", and the compose key is specific to your system (I've 
> mapped it to AltGr+Win here).

I had to use gnome-tweaks to configure the compose key.
Thanks for the hint.

> 
>> Fortunately - you've now given me a character I can copy and paste.
>>  (yes, of course it was already in my e-mail client)
>>
>> Perhaps I was giving you a chance to increase your patch count with a
>> fixup patch later ;-)
>>
>>>> +
>>>> +# The short X.Y version
>>>> +version = ''
>>>> +# The full version, including alpha/beta/rc tags
>>>> +release = '0.1'
>>>> +
>>>> +
>>>> +# -- 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 = [
>>>> +]
>>>> +
>>>> +# Add any paths that contain templates here, relative to this directory.
>>>> +templates_path = ['_templates']
> 
> Do we have templates ? :-)

No (not currently)
 - but both _templates and _static are created by sphinx-quickstart.

Perhaps I should add a .keep_empty file into those directories so they
can be added to git, to define the structure hierarchy ?

I've done this locally ... as I believe it's the right thing to do so far.

>>>> +# The suffix(es) of source filenames.
>>>> +# You can specify multiple suffix as a list of string:
>>>> +#
>>>> +# source_suffix = ['.rst', '.md']
>>>> +source_suffix = '.rst'
>>>> +
>>>> +# The master toctree document.
>>>> +master_doc = 'index'
>>>> +
>>>> +# 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
>>>> +
>>>> +# List of patterns, relative to source directory, that match files and
>>>> +# directories to ignore when looking for source files.
>>>> +# This pattern also affects html_static_path and html_extra_path.
>>>> +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
>>>> +
>>>> +# The name of the Pygments (syntax highlighting) style to use.
>>>> +pygments_style = None
>>>> +
>>>> +
>>>> +# -- 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 = 'alabaster'
> 
> Exercise for the reader : develop a theme matching http://www.libcamera.org.

I think we should focus on getting some content in as a higher priority
that designing a custom theme. It should be done - but it will take
time. Of course contributions welcome.


Would you foresee this generated documentation replacing the current
content at libcamera.org entirely?



>>>> +# 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 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']
>>>> +
>>>> +# Custom sidebar templates, must be a dictionary that maps document
>>>> names
>>>> +# to template names.
>>>> +#
>>>> +# The default sidebars (for documents that don't match any pattern) are
>>>> +# defined by theme itself.  Builtin themes are using these templates by
>>>> +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
>>>> +# 'searchbox.html']``.
>>>> +#
>>>> +# html_sidebars = {}
>>>> +
>>>> +
>>>> +# -- Options for HTMLHelp output ---------------------------------------
>>>> +
>>>> +# Output file base name for HTML help builder.
>>>> +htmlhelp_basename = 'LibCameradoc'
>>>> +
>>>> +
>>>> +# -- 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, 'LibCamera.tex', 'LibCamera Documentation',
>>>> +     'Kieran Bingham, Jacopo Mondi, Laurent Pinchart, Niklas Soderlund',
>>>> 'manual'),
>>>
>>> :-)
>>
>> I'll update here as well.
>>
>>>> +]
>>>> +
>>>> +
>>>> +# -- 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, 'libcamera', 'LibCamera Documentation',
>>>> +     [author], 1)
>>>> +]
>>>> +
>>>> +
>>>> +# -- 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, 'LibCamera', 'LibCamera Documentation',
>>>> +     author, 'LibCamera', 'One line description of project.',
>>>> +     'Miscellaneous'),
>>>> +]
>>>> +
>>>> +
>>>> +# -- Options for Epub output
>>>> ------------------------------------------------- +
>>>> +# Bibliographic Dublin Core info.
>>>> +epub_title = project
>>>> +
>>>> +# The unique identifier of the text. This can be a ISBN number
>>>> +# or the project homepage.
>>>> +#
>>>> +# epub_identifier = ''
>>>> +
>>>> +# A unique identification for the text.
>>>> +#
>>>> +# epub_uid = ''
>>>> +
>>>> +# A list of files that should not be packed into the epub file.
>>>> +epub_exclude_files = ['search.html']
> 
> As we don't use latex, man pages, texinfo and epub, should we remove those 
> sections for now ?

I'd rather keep them, and in the future, add targets to generate them.
(if the required tools are available)



>>>> \ No newline at end of file
> 
> No newline at end of file ?

That's how it was autogenerated :-)

I've added it.


> 
>>>> diff --git a/Documentation/hacking.rst b/Documentation/hacking.rst
>>>> new file mode 100644
>>>> index 000000000000..2dbee7f2b88d
>>>> --- /dev/null
>>>> +++ b/Documentation/hacking.rst
> 
> The website currently stores the information below in a "Contribute" section. 
> I think that name is a bit more positive than "hacking" and would prefer 
> retaining it.

I've done a global : s/hacking/contributing/

> 
>>>> @@ -0,0 +1,42 @@
>>>> +Hacking and Development
> 
> Same here.
> 
>>>> +=======================
>>>> +
>>>> +libcamera is developed as a free software project and welcomes
>>>> contributors.
>>>> +Whether you would like to help with coding, documentation, testing,
>>>> proposing
>>>> +new features, or just discussing the project with the community, you can
>>>> join
>>>> +our official public communication channels, or simply check out the
>>>> code.
>>>> +Mailing List
>>>
>>> This seems odd, should not the 'Mailing List' also have a line of - to
>>> make it a subsection?
>>
>> Ah yes, thank you I had missed that. This was just a copy paste from the
>> website.
>>
>>> With these issues addressed feel free to add
>>>
>>> Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
>>
>> I'll take this and commit to master :)>>
>>>> +
>>>> +We use a public mailing list as our main means of communication. You can
>>>> find
>>>> +subscription information and the messages archive on the libcamera-devel
>>>> list
>>>> +information page.
>>
>> It might help if I add a link to the libcamera-devel list page here too :)
> 
> Agreed.

Added.


> 
>>>> +
>>>> +IRC Channel
>>>> +-----------
>>>> +
>>>> +For informal and real time discussions, our IRC channel on Freenode is
>>>> open to
>>>> +the public. Point your IRC client to #libcamera to say hello,
>>>> or use the `WebChat`_.
>>>> +
>>>> +.. _WebChat: https://webchat.freenode.net/?channels=%23libcamera&uio=d4
>>>> +
>>>> +Source Code
>>>> +-----------
>>>> +
>>>> +libcamera is in early stages of development, and no releases are
>>>> available yet.
>>>> +The source code is available from the project's git tree, hosted by
>>>> LinuxTV.
>>>> +
>>>> +  $ git clone git://linuxtv.org/libcamera.git
>>>> +
>>>> +Documentation
>>>> +-------------
>>>> +
>>>> +Project documentation is created using `Sphinx`_.  Source level
>>>> documentation
>>>> +is currently planned to utilise Doxygen integration. Please use this in
>>>> your
>>>> +development.
>>>> +
>>>> +Sphinx integration with Doxygen will be with either `Breathe`_ or
>>>> `Exhale`_
>>>> +depending upon which system works best
>>>> +
>>>> +.. _Sphinx: http://www.sphinx-doc.org
>>>> +.. _Breathe: https://breathe.readthedocs.io/en/latest/
>>>> +.. _Exhale: https://exhale.readthedocs.io/en/latest/
>>>> diff --git a/Documentation/index.rst b/Documentation/index.rst
>>>> new file mode 100644
>>>> index 000000000000..962192ec8ee8
>>>> --- /dev/null
>>>> +++ b/Documentation/index.rst
>>>> @@ -0,0 +1,30 @@
>>>> +LibCamera abstraction library
> 
> Similarly here, you should write "libcamera". "libcamera library" seems a bit 
> redundant to me. Other options could be "Linux Camera Library", "Linux Camera 
> Support Library", "Linux Camera Framework", "Linux Camera Framework Library" 
> (possibly without the "Linux" prefix, even though the project targets Linux 
> only).

Shortened to just libcamera

> 
>>>> +=============================
>>>> +
>>>> +Cameras are complex devices that need heavy hardware image processing
>>>> +operations. Control of the processing is based on advanced algorithms
>>>> that must +run on a programmable processor. This has traditionally been
>>>> implemented in a +dedicated MCU in the camera, but in embedded devices
>>>> algorithms have been moved +to the main CPU to save cost. Blurring the
>>>> boundary between camera devices and +Linux often left the user with no
>>>> other option than a vendor-specific +closed-source solution.
>>>> +
>>>> +To address this problem the Linux media community has very recently
>>>> started +collaboration with the industry to develop a camera stack that
>>>> will be +open-source-friendly while still protecting vendor core IP.
>>>> libcamera was born +out of that collaboration and will offer modern
>>>> camera support to Linux-based +systems, including traditional Linux
>>>> distributions, ChromeOS and Android. +
>>>> +
>>>> +.. toctree::
>>>> +   :maxdepth: 2
>>>> +   :caption: Contents:
>>>> +
>>>> +   hacking
>>>> +
>>>> +
>>>> +Indices and tables
>>>> +==================
>>>> +
>>>> +* :ref:`genindex`
>>>> +* :ref:`search`
>>>> diff --git a/Documentation/meson.build b/Documentation/meson.build
>>>> new file mode 100644
>>>> index 000000000000..5ab04479d3fb
>>>> --- /dev/null
>>>> +++ b/Documentation/meson.build
>>>> @@ -0,0 +1,20 @@
>>>> +sphinx = find_program('sphinx-build-3', required: false)
>>>> +if not sphinx.found()
>>>> +    sphinx = find_program('sphinx-build', required: false)
>>>> +endif
>>>> +
>>>> +if sphinx.found()
>>>> +    docs_sources = [
>>>> +	'hacking.rst',
>>>> +	'index.rst',
>>>> +    ]
>>>> +
>>>> +    custom_target('en user documentation',
> 
> What does this stand for ? English user documentation ? End user documentation 

English.

Perhaps it's unlikely that we'll do translations, but the sample
meson.build I saw utilised this.

I'll drop it (references to en), it's unlikely to happen, and we can
always indent if needed then.

This particular string is simply the text shown by ninja in this compile
stage.


> ?
> 
>>>> +		  command: [sphinx, '-W', '-b', 'html', meson.current_source_dir(),
>>>> '@OUTPUT@'],
>>>> +		  input: docs_sources,
>>>> +		  output: 'en',
>>>> +		  build_by_default: true)
>>>> +
>>>> +    install_subdir(meson.current_build_dir() + '/en',
>>>> +		  install_dir: 'share/doc/libcamera-@0@/user'.format(api_version))
> 
> Why the user/ directory ?

It was from the example integration. I can remove.

I think it was distinguishing between documentation for a user utilising
the library API, and a separate set for developing on the library.

Do you think we should have a similar split of documentation?
Or all in one?


> 
>>>> +endif
> 
> [snip]
>

Hi Kieran,

On Friday, 23 November 2018 19:58:43 EET Kieran Bingham wrote:
> On 23/11/2018 15:25, Laurent Pinchart wrote:
> > On Friday, 23 November 2018 16:12:54 EET Kieran Bingham wrote:
> >> On 23/11/2018 13:19, Niklas Söderlund wrote:
> >>> On 2018-11-22 16:58:52 +0000, Kieran Bingham wrote:
> >>>> Utilise sphinx-build to generate documentation in HTML form, and
> >>>> populate with some initial content.
> >>>> 
> >>>> An initial conf.py is generated from sphinx-quickstart and answering
> >>>> initial questions.
> >>>> 
> >>>> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
> >>>> 
> >>>> ---
> >>>> 
> >>>> v2:
> >>>>  - Fix spelling in hacking.rst
> >>>>  - Remove autogenerated comments at index.rst
> >>>>  - Fix whitespaces
> >>>>  - Remove autogenerated Makefile
> >>>>  - Fix typos and grammar
> >>>>  
> >>>>  Documentation/conf.py     | 173 ++++++++++++++++++++++++++++++++++++++
> >>>>  Documentation/hacking.rst |  42 +++++++++
> >>>>  Documentation/index.rst   |  30 +++++++
> >>>>  Documentation/meson.build |  20 +++++
> >>>>  meson.build               |   6 ++
> >>>>  5 files changed, 271 insertions(+)
> >>>>  create mode 100644 Documentation/conf.py
> >>>>  create mode 100644 Documentation/hacking.rst
> >>>>  create mode 100644 Documentation/index.rst
> >>>>  create mode 100644 Documentation/meson.build
> >>>> 
> >>>> diff --git a/Documentation/conf.py b/Documentation/conf.py
> >>>> new file mode 100644
> >>>> index 000000000000..70d4e72c6902
> >>>> --- /dev/null
> >>>> +++ b/Documentation/conf.py
> >>>> @@ -0,0 +1,173 @@
> >>>> +# -*- coding: utf-8 -*-
> >>>> +#
> >>>> +# Configuration file for the Sphinx documentation builder.
> >>>> +#
> >>>> +# This file does only contain a selection of the most common options.
> >>>> For a
> >>>> +# full list see the documentation:
> >>>> +# http://www.sphinx-doc.org/en/master/config
> >>>> +
> >>>> +# -- Path setup
> >>>> --------------------------------------------------------
> >>>> +
> >>>> +# 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, os.path.abspath('.'))
> > 
> > Should we remove the commented out options (and sections) ?
> 
> Personally - I would say no.
> 
> (I fairly intentionally left the auto-generated file as it was generated)
> 
> This is essentially the closest (proximity) documentation for modifying
> conf.py.

I'm fine with that.

> >>>> +# -- Project information
> >>>> -----------------------------------------------
> >>>> +
> >>>> +project = 'LibCamera'
> > 
> > Nitpicking, the project is called "libcamera" throughout the existing
> > documentation.
> 
> Ah yes, I'll correct it.
> 
> >>>> +copyright = '2018, Kieran Bingham, Jacopo Mondi, Laurent Pinchart,
> >>>> Niklas Soderlund' +author = 'Kieran Bingham, Jacopo Mondi, Laurent
> >>>> Pinchart, Niklas Soderlund'
> >>> 
> >>> My pretty döts seems to me missing :-)
> >> 
> >> I have no idea how to generate those on my keyboard...
> > 
> > Compose, u, "
> 
> ↓" "↓²ø² nope
> 
> ö - Aha - got it.

The other option, of course, is to get a Belgian keyboard ;-)

> > "," means "followed by", and the compose key is specific to your system
> > (I've mapped it to AltGr+Win here).
> 
> I had to use gnome-tweaks to configure the compose key.
> Thanks for the hint.
> 
> >> Fortunately - you've now given me a character I can copy and paste.
> >> 
> >>  (yes, of course it was already in my e-mail client)
> >> 
> >> Perhaps I was giving you a chance to increase your patch count with a
> >> fixup patch later ;-)
> >> 
> >>>> +
> >>>> +# The short X.Y version
> >>>> +version = ''
> >>>> +# The full version, including alpha/beta/rc tags
> >>>> +release = '0.1'
> >>>> +
> >>>> +
> >>>> +# -- 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 = [
> >>>> +]
> >>>> +
> >>>> +# Add any paths that contain templates here, relative to this
> >>>> directory.
> >>>> +templates_path = ['_templates']
> > 
> > Do we have templates ? :-)
> 
> No (not currently)
>  - but both _templates and _static are created by sphinx-quickstart.
> 
> Perhaps I should add a .keep_empty file into those directories so they
> can be added to git, to define the structure hierarchy ?
> 
> I've done this locally ... as I believe it's the right thing to do so far.

What happens if someone clones the repository without those directories and 
attempts to build the documentation ? If it works we can keep it as-is, if it 
requires empty _templates and _static directories then they should be in the 
repository.

> >>>> +# The suffix(es) of source filenames.
> >>>> +# You can specify multiple suffix as a list of string:
> >>>> +#
> >>>> +# source_suffix = ['.rst', '.md']
> >>>> +source_suffix = '.rst'
> >>>> +
> >>>> +# The master toctree document.
> >>>> +master_doc = 'index'
> >>>> +
> >>>> +# 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
> >>>> +
> >>>> +# List of patterns, relative to source directory, that match files and
> >>>> +# directories to ignore when looking for source files.
> >>>> +# This pattern also affects html_static_path and html_extra_path.
> >>>> +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
> >>>> +
> >>>> +# The name of the Pygments (syntax highlighting) style to use.
> >>>> +pygments_style = None
> >>>> +
> >>>> +
> >>>> +# -- 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 = 'alabaster'
> > 
> > Exercise for the reader : develop a theme matching
> > http://www.libcamera.org.
> 
> I think we should focus on getting some content in as a higher priority
> that designing a custom theme. It should be done - but it will take
> time. Of course contributions welcome.

Sure. The reader wasn't meant to be you :-)

> Would you foresee this generated documentation replacing the current
> content at libcamera.org entirely?

Yes, I think we should aim for that, in order to keep the website in sync with 
the source code. I would keep the front page static though, and I expect 
Documentation/index.rst to diverge at some point. I'm not sure about the 
"Contribute" page, and to what extent it makes sense to include it in the 
library documentation though, but I'm fine keeping the content as you've done 
in this patch.

> >>>> +# 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 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']
> >>>> +
> >>>> +# Custom sidebar templates, must be a dictionary that maps document
> >>>> names
> >>>> +# to template names.
> >>>> +#
> >>>> +# The default sidebars (for documents that don't match any pattern)
> >>>> are
> >>>> +# defined by theme itself.  Builtin themes are using these templates
> >>>> by
> >>>> +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
> >>>> +# 'searchbox.html']``.
> >>>> +#
> >>>> +# html_sidebars = {}
> >>>> +
> >>>> +
> >>>> +# -- Options for HTMLHelp output -------------------------------------
> >>>> +
> >>>> +# Output file base name for HTML help builder.
> >>>> +htmlhelp_basename = 'LibCameradoc'
> >>>> +
> >>>> +
> >>>> +# -- 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, 'LibCamera.tex', 'LibCamera Documentation',
> >>>> +     'Kieran Bingham, Jacopo Mondi, Laurent Pinchart, Niklas
> >>>> Soderlund',
> >>>> 'manual'),
> >>>> 
> >>> :-)
> >> 
> >> I'll update here as well.
> >> 
> >>>> +]
> >>>> +
> >>>> +
> >>>> +# -- 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, 'libcamera', 'LibCamera Documentation',
> >>>> +     [author], 1)
> >>>> +]
> >>>> +
> >>>> +
> >>>> +# -- 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, 'LibCamera', 'LibCamera Documentation',
> >>>> +     author, 'LibCamera', 'One line description of project.',
> >>>> +     'Miscellaneous'),
> >>>> +]
> >>>> +
> >>>> +
> >>>> +# -- Options for Epub output -----------------------------------------
> >>>> +
> >>>> +# Bibliographic Dublin Core info.
> >>>> +epub_title = project
> >>>> +
> >>>> +# The unique identifier of the text. This can be a ISBN number
> >>>> +# or the project homepage.
> >>>> +#
> >>>> +# epub_identifier = ''
> >>>> +
> >>>> +# A unique identification for the text.
> >>>> +#
> >>>> +# epub_uid = ''
> >>>> +
> >>>> +# A list of files that should not be packed into the epub file.
> >>>> +epub_exclude_files = ['search.html']
> > 
> > As we don't use latex, man pages, texinfo and epub, should we remove those
> > sections for now ?
> 
> I'd rather keep them, and in the future, add targets to generate them.
> (if the required tools are available)
> 
> >>>> \ No newline at end of file
> > 
> > No newline at end of file ?
> 
> That's how it was autogenerated :-)
> 
> I've added it.
> 
> >>>> diff --git a/Documentation/hacking.rst b/Documentation/hacking.rst
> >>>> new file mode 100644
> >>>> index 000000000000..2dbee7f2b88d
> >>>> --- /dev/null
> >>>> +++ b/Documentation/hacking.rst
> > 
> > The website currently stores the information below in a "Contribute"
> > section. I think that name is a bit more positive than "hacking" and
> > would prefer retaining it.
> 
> I've done a global : s/hacking/contributing/
> 
> >>>> @@ -0,0 +1,42 @@
> >>>> +Hacking and Development
> > 
> > Same here.
> > 
> >>>> +=======================
> >>>> +
> >>>> +libcamera is developed as a free software project and welcomes
> >>>> contributors.
> >>>> +Whether you would like to help with coding, documentation, testing,
> >>>> proposing
> >>>> +new features, or just discussing the project with the community, you
> >>>> can join
> >>>> +our official public communication channels, or simply check out the
> >>>> code.
> >>>> +Mailing List
> >>> 
> >>> This seems odd, should not the 'Mailing List' also have a line of - to
> >>> make it a subsection?
> >> 
> >> Ah yes, thank you I had missed that. This was just a copy paste from the
> >> website.
> >> 
> >>> With these issues addressed feel free to add
> >>> 
> >>> Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
> >> 
> >> I'll take this and commit to master :)
> >> 
> >>>> +
> >>>> +We use a public mailing list as our main means of communication. You
> >>>> can find
> >>>> +subscription information and the messages archive on the
> >>>> libcamera-devel list
> >>>> +information page.
> >> 
> >> It might help if I add a link to the libcamera-devel list page here too
> >> :)
> > 
> > Agreed.
> 
> Added.
> 
> >>>> +
> >>>> +IRC Channel
> >>>> +-----------
> >>>> +
> >>>> +For informal and real time discussions, our IRC channel on Freenode is
> >>>> open to
> >>>> +the public. Point your IRC client to #libcamera to say hello,
> >>>> or use the `WebChat`_.
> >>>> +
> >>>> +.. _WebChat:
> >>>> https://webchat.freenode.net/?channels=%23libcamera&uio=d4
> >>>> +
> >>>> +Source Code
> >>>> +-----------
> >>>> +
> >>>> +libcamera is in early stages of development, and no releases are
> >>>> available yet.
> >>>> +The source code is available from the project's git tree, hosted by
> >>>> LinuxTV.
> >>>> +
> >>>> +  $ git clone git://linuxtv.org/libcamera.git
> >>>> +
> >>>> +Documentation
> >>>> +-------------
> >>>> +
> >>>> +Project documentation is created using `Sphinx`_.  Source level
> >>>> documentation
> >>>> +is currently planned to utilise Doxygen integration. Please use this
> >>>> in your
> >>>> +development.
> >>>> +
> >>>> +Sphinx integration with Doxygen will be with either `Breathe`_ or
> >>>> `Exhale`_
> >>>> +depending upon which system works best
> >>>> +
> >>>> +.. _Sphinx: http://www.sphinx-doc.org
> >>>> +.. _Breathe: https://breathe.readthedocs.io/en/latest/
> >>>> +.. _Exhale: https://exhale.readthedocs.io/en/latest/
> >>>> diff --git a/Documentation/index.rst b/Documentation/index.rst
> >>>> new file mode 100644
> >>>> index 000000000000..962192ec8ee8
> >>>> --- /dev/null
> >>>> +++ b/Documentation/index.rst
> >>>> @@ -0,0 +1,30 @@
> >>>> +LibCamera abstraction library
> > 
> > Similarly here, you should write "libcamera". "libcamera library" seems a
> > bit redundant to me. Other options could be "Linux Camera Library",
> > "Linux Camera Support Library", "Linux Camera Framework", "Linux Camera
> > Framework Library" (possibly without the "Linux" prefix, even though the
> > project targets Linux only).
> 
> Shortened to just libcamera

Works for me.

> >>>> +=============================
> >>>> +
> >>>> +Cameras are complex devices that need heavy hardware image processing
> >>>> +operations. Control of the processing is based on advanced algorithms
> >>>> that must +run on a programmable processor. This has traditionally been
> >>>> implemented in a +dedicated MCU in the camera, but in embedded devices
> >>>> algorithms have been moved +to the main CPU to save cost. Blurring the
> >>>> boundary between camera devices and +Linux often left the user with no
> >>>> other option than a vendor-specific +closed-source solution.
> >>>> +
> >>>> +To address this problem the Linux media community has very recently
> >>>> started +collaboration with the industry to develop a camera stack that
> >>>> will be +open-source-friendly while still protecting vendor core IP.
> >>>> libcamera was born +out of that collaboration and will offer modern
> >>>> camera support to Linux-based +systems, including traditional Linux
> >>>> distributions, ChromeOS and Android. +
> >>>> +
> >>>> +.. toctree::
> >>>> +   :maxdepth: 2
> >>>> +   :caption: Contents:
> >>>> +
> >>>> +   hacking
> >>>> +
> >>>> +
> >>>> +Indices and tables
> >>>> +==================
> >>>> +
> >>>> +* :ref:`genindex`
> >>>> +* :ref:`search`
> >>>> diff --git a/Documentation/meson.build b/Documentation/meson.build
> >>>> new file mode 100644
> >>>> index 000000000000..5ab04479d3fb
> >>>> --- /dev/null
> >>>> +++ b/Documentation/meson.build
> >>>> @@ -0,0 +1,20 @@
> >>>> +sphinx = find_program('sphinx-build-3', required: false)
> >>>> +if not sphinx.found()
> >>>> +    sphinx = find_program('sphinx-build', required: false)
> >>>> +endif
> >>>> +
> >>>> +if sphinx.found()
> >>>> +    docs_sources = [
> >>>> +	'hacking.rst',
> >>>> +	'index.rst',
> >>>> +    ]
> >>>> +
> >>>> +    custom_target('en user documentation',
> > 
> > What does this stand for ? English user documentation ? End user
> > documentation
> 
> English.
> 
> Perhaps it's unlikely that we'll do translations, but the sample
> meson.build I saw utilised this.
> 
> I'll drop it (references to en), it's unlikely to happen, and we can
> always indent if needed then.
> 
> This particular string is simply the text shown by ninja in this compile
> stage.

Let's just go for "documentation" for now then. I don't think we'll translate 
it any time soon :-)

How are custom targets invoked with ninja ? You're building the documentation 
by default, and I think that's the right thing to do in order to catch errors, 
but what if the target wasn't build_by_default, how would it be invoked ?

> > ?
> > 
> >>>> +		  command: [sphinx, '-W', '-b', 'html', 
meson.current_source_dir(),
> >>>> '@OUTPUT@'],
> >>>> +		  input: docs_sources,
> >>>> +		  output: 'en',
> >>>> +		  build_by_default: true)
> >>>> +
> >>>> +    install_subdir(meson.current_build_dir() + '/en',
> >>>> +		  install_dir: 'share/doc/libcamera-@0@/
user'.format(api_version))
> > 
> > Why the user/ directory ?
> 
> It was from the example integration. I can remove.
> 
> I think it was distinguishing between documentation for a user utilising
> the library API, and a separate set for developing on the library.
> 
> Do you think we should have a similar split of documentation?
> Or all in one?

I would go for all in one to start with. If we need to split later we'll do 
it.

> >>>> +endif
> > 
> > [snip]

Hi Laurent,

On 23/11/2018 18:43, Laurent Pinchart wrote:
> Hi Kieran,
> 
> On Friday, 23 November 2018 19:58:43 EET Kieran Bingham wrote:
>> On 23/11/2018 15:25, Laurent Pinchart wrote:
>>> On Friday, 23 November 2018 16:12:54 EET Kieran Bingham wrote:
>>>> On 23/11/2018 13:19, Niklas Söderlund wrote:
>>>>> On 2018-11-22 16:58:52 +0000, Kieran Bingham wrote:
>>>>>> Utilise sphinx-build to generate documentation in HTML form, and
>>>>>> populate with some initial content.
>>>>>>
>>>>>> An initial conf.py is generated from sphinx-quickstart and answering
>>>>>> initial questions.
>>>>>>
>>>>>> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
>>>>>>
>>>>>> ---
>>>>>>
>>>>>> v2:
>>>>>>  - Fix spelling in hacking.rst
>>>>>>  - Remove autogenerated comments at index.rst
>>>>>>  - Fix whitespaces
>>>>>>  - Remove autogenerated Makefile
>>>>>>  - Fix typos and grammar
>>>>>>  
>>>>>>  Documentation/conf.py     | 173 ++++++++++++++++++++++++++++++++++++++
>>>>>>  Documentation/hacking.rst |  42 +++++++++
>>>>>>  Documentation/index.rst   |  30 +++++++
>>>>>>  Documentation/meson.build |  20 +++++
>>>>>>  meson.build               |   6 ++
>>>>>>  5 files changed, 271 insertions(+)
>>>>>>  create mode 100644 Documentation/conf.py
>>>>>>  create mode 100644 Documentation/hacking.rst
>>>>>>  create mode 100644 Documentation/index.rst
>>>>>>  create mode 100644 Documentation/meson.build
>>>>>>
>>>>>> diff --git a/Documentation/conf.py b/Documentation/conf.py
>>>>>> new file mode 100644
>>>>>> index 000000000000..70d4e72c6902
>>>>>> --- /dev/null
>>>>>> +++ b/Documentation/conf.py
>>>>>> @@ -0,0 +1,173 @@
>>>>>> +# -*- coding: utf-8 -*-
>>>>>> +#
>>>>>> +# Configuration file for the Sphinx documentation builder.
>>>>>> +#
>>>>>> +# This file does only contain a selection of the most common options.
>>>>>> For a
>>>>>> +# full list see the documentation:
>>>>>> +# http://www.sphinx-doc.org/en/master/config
>>>>>> +
>>>>>> +# -- Path setup
>>>>>> --------------------------------------------------------
>>>>>> +
>>>>>> +# 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, os.path.abspath('.'))
>>>
>>> Should we remove the commented out options (and sections) ?
>>
>> Personally - I would say no.
>>
>> (I fairly intentionally left the auto-generated file as it was generated)
>>
>> This is essentially the closest (proximity) documentation for modifying
>> conf.py.
> 
> I'm fine with that.
> 
>>>>>> +# -- Project information
>>>>>> -----------------------------------------------
>>>>>> +
>>>>>> +project = 'LibCamera'
>>>
>>> Nitpicking, the project is called "libcamera" throughout the existing
>>> documentation.
>>
>> Ah yes, I'll correct it.
>>
>>>>>> +copyright = '2018, Kieran Bingham, Jacopo Mondi, Laurent Pinchart,
>>>>>> Niklas Soderlund' +author = 'Kieran Bingham, Jacopo Mondi, Laurent
>>>>>> Pinchart, Niklas Soderlund'
>>>>>
>>>>> My pretty döts seems to me missing :-)
>>>>
>>>> I have no idea how to generate those on my keyboard...
>>>
>>> Compose, u, "
>>
>> ↓" "↓²ø² nope
>>
>> ö - Aha - got it.
> 
> The other option, of course, is to get a Belgian keyboard ;-)
> 
>>> "," means "followed by", and the compose key is specific to your system
>>> (I've mapped it to AltGr+Win here).
>>
>> I had to use gnome-tweaks to configure the compose key.
>> Thanks for the hint.
>>
>>>> Fortunately - you've now given me a character I can copy and paste.
>>>>
>>>>  (yes, of course it was already in my e-mail client)
>>>>
>>>> Perhaps I was giving you a chance to increase your patch count with a
>>>> fixup patch later ;-)
>>>>
>>>>>> +
>>>>>> +# The short X.Y version
>>>>>> +version = ''
>>>>>> +# The full version, including alpha/beta/rc tags
>>>>>> +release = '0.1'
>>>>>> +
>>>>>> +
>>>>>> +# -- 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 = [
>>>>>> +]
>>>>>> +
>>>>>> +# Add any paths that contain templates here, relative to this
>>>>>> directory.
>>>>>> +templates_path = ['_templates']
>>>
>>> Do we have templates ? :-)
>>
>> No (not currently)
>>  - but both _templates and _static are created by sphinx-quickstart.
>>
>> Perhaps I should add a .keep_empty file into those directories so they
>> can be added to git, to define the structure hierarchy ?
>>
>> I've done this locally ... as I believe it's the right thing to do so far.
> 
> What happens if someone clones the repository without those directories and 
> attempts to build the documentation ? If it works we can keep it as-is, if it 
> requires empty _templates and _static directories then they should be in the 
> repository.


It seems that _static *must* exist. _templates is optional.
However, if I'm adding one, I'd rather add both as they represent the
structure of the framework rather than content.



>>>>>> +# The suffix(es) of source filenames.
>>>>>> +# You can specify multiple suffix as a list of string:
>>>>>> +#
>>>>>> +# source_suffix = ['.rst', '.md']
>>>>>> +source_suffix = '.rst'
>>>>>> +
>>>>>> +# The master toctree document.
>>>>>> +master_doc = 'index'
>>>>>> +
>>>>>> +# 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
>>>>>> +
>>>>>> +# List of patterns, relative to source directory, that match files and
>>>>>> +# directories to ignore when looking for source files.
>>>>>> +# This pattern also affects html_static_path and html_extra_path.
>>>>>> +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
>>>>>> +
>>>>>> +# The name of the Pygments (syntax highlighting) style to use.
>>>>>> +pygments_style = None
>>>>>> +
>>>>>> +
>>>>>> +# -- 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 = 'alabaster'
>>>
>>> Exercise for the reader : develop a theme matching
>>> http://www.libcamera.org.
>>
>> I think we should focus on getting some content in as a higher priority
>> that designing a custom theme. It should be done - but it will take
>> time. Of course contributions welcome.
> 
> Sure. The reader wasn't meant to be you :-)
> 
>> Would you foresee this generated documentation replacing the current
>> content at libcamera.org entirely?
> 
> Yes, I think we should aim for that, in order to keep the website in sync with 
> the source code. I would keep the front page static though, and I expect 
> Documentation/index.rst to diverge at some point. I'm not sure about the 
> "Contribute" page, and to what extent it makes sense to include it in the 
> library documentation though, but I'm fine keeping the content as you've done 
> in this patch.

Ok - well my main aim at the moment is ensuring we have a framework to
move forwards with, which I think this patch pretty much does.


>>>>>> +# 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 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']
>>>>>> +
>>>>>> +# Custom sidebar templates, must be a dictionary that maps document
>>>>>> names
>>>>>> +# to template names.
>>>>>> +#
>>>>>> +# The default sidebars (for documents that don't match any pattern)
>>>>>> are
>>>>>> +# defined by theme itself.  Builtin themes are using these templates
>>>>>> by
>>>>>> +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
>>>>>> +# 'searchbox.html']``.
>>>>>> +#
>>>>>> +# html_sidebars = {}
>>>>>> +
>>>>>> +
>>>>>> +# -- Options for HTMLHelp output -------------------------------------
>>>>>> +
>>>>>> +# Output file base name for HTML help builder.
>>>>>> +htmlhelp_basename = 'LibCameradoc'
>>>>>> +
>>>>>> +
>>>>>> +# -- 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, 'LibCamera.tex', 'LibCamera Documentation',
>>>>>> +     'Kieran Bingham, Jacopo Mondi, Laurent Pinchart, Niklas
>>>>>> Soderlund',
>>>>>> 'manual'),
>>>>>>
>>>>> :-)
>>>>
>>>> I'll update here as well.
>>>>
>>>>>> +]
>>>>>> +
>>>>>> +
>>>>>> +# -- 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, 'libcamera', 'LibCamera Documentation',
>>>>>> +     [author], 1)
>>>>>> +]
>>>>>> +
>>>>>> +
>>>>>> +# -- 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, 'LibCamera', 'LibCamera Documentation',
>>>>>> +     author, 'LibCamera', 'One line description of project.',
>>>>>> +     'Miscellaneous'),
>>>>>> +]
>>>>>> +
>>>>>> +
>>>>>> +# -- Options for Epub output -----------------------------------------
>>>>>> +
>>>>>> +# Bibliographic Dublin Core info.
>>>>>> +epub_title = project
>>>>>> +
>>>>>> +# The unique identifier of the text. This can be a ISBN number
>>>>>> +# or the project homepage.
>>>>>> +#
>>>>>> +# epub_identifier = ''
>>>>>> +
>>>>>> +# A unique identification for the text.
>>>>>> +#
>>>>>> +# epub_uid = ''
>>>>>> +
>>>>>> +# A list of files that should not be packed into the epub file.
>>>>>> +epub_exclude_files = ['search.html']
>>>
>>> As we don't use latex, man pages, texinfo and epub, should we remove those
>>> sections for now ?
>>
>> I'd rather keep them, and in the future, add targets to generate them.
>> (if the required tools are available)
>>
>>>>>> \ No newline at end of file
>>>
>>> No newline at end of file ?
>>
>> That's how it was autogenerated :-)
>>
>> I've added it.
>>
>>>>>> diff --git a/Documentation/hacking.rst b/Documentation/hacking.rst
>>>>>> new file mode 100644
>>>>>> index 000000000000..2dbee7f2b88d
>>>>>> --- /dev/null
>>>>>> +++ b/Documentation/hacking.rst
>>>
>>> The website currently stores the information below in a "Contribute"
>>> section. I think that name is a bit more positive than "hacking" and
>>> would prefer retaining it.
>>
>> I've done a global : s/hacking/contributing/
>>
>>>>>> @@ -0,0 +1,42 @@
>>>>>> +Hacking and Development
>>>
>>> Same here.
>>>
>>>>>> +=======================
>>>>>> +
>>>>>> +libcamera is developed as a free software project and welcomes
>>>>>> contributors.
>>>>>> +Whether you would like to help with coding, documentation, testing,
>>>>>> proposing
>>>>>> +new features, or just discussing the project with the community, you
>>>>>> can join
>>>>>> +our official public communication channels, or simply check out the
>>>>>> code.
>>>>>> +Mailing List
>>>>>
>>>>> This seems odd, should not the 'Mailing List' also have a line of - to
>>>>> make it a subsection?
>>>>
>>>> Ah yes, thank you I had missed that. This was just a copy paste from the
>>>> website.
>>>>
>>>>> With these issues addressed feel free to add
>>>>>
>>>>> Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
>>>>
>>>> I'll take this and commit to master :)
>>>>
>>>>>> +
>>>>>> +We use a public mailing list as our main means of communication. You
>>>>>> can find
>>>>>> +subscription information and the messages archive on the
>>>>>> libcamera-devel list
>>>>>> +information page.
>>>>
>>>> It might help if I add a link to the libcamera-devel list page here too
>>>> :)
>>>
>>> Agreed.
>>
>> Added.
>>
>>>>>> +
>>>>>> +IRC Channel
>>>>>> +-----------
>>>>>> +
>>>>>> +For informal and real time discussions, our IRC channel on Freenode is
>>>>>> open to
>>>>>> +the public. Point your IRC client to #libcamera to say hello,
>>>>>> or use the `WebChat`_.
>>>>>> +
>>>>>> +.. _WebChat:
>>>>>> https://webchat.freenode.net/?channels=%23libcamera&uio=d4
>>>>>> +
>>>>>> +Source Code
>>>>>> +-----------
>>>>>> +
>>>>>> +libcamera is in early stages of development, and no releases are
>>>>>> available yet.
>>>>>> +The source code is available from the project's git tree, hosted by
>>>>>> LinuxTV.
>>>>>> +
>>>>>> +  $ git clone git://linuxtv.org/libcamera.git
>>>>>> +
>>>>>> +Documentation
>>>>>> +-------------
>>>>>> +
>>>>>> +Project documentation is created using `Sphinx`_.  Source level
>>>>>> documentation
>>>>>> +is currently planned to utilise Doxygen integration. Please use this
>>>>>> in your
>>>>>> +development.
>>>>>> +
>>>>>> +Sphinx integration with Doxygen will be with either `Breathe`_ or
>>>>>> `Exhale`_
>>>>>> +depending upon which system works best
>>>>>> +
>>>>>> +.. _Sphinx: http://www.sphinx-doc.org
>>>>>> +.. _Breathe: https://breathe.readthedocs.io/en/latest/
>>>>>> +.. _Exhale: https://exhale.readthedocs.io/en/latest/
>>>>>> diff --git a/Documentation/index.rst b/Documentation/index.rst
>>>>>> new file mode 100644
>>>>>> index 000000000000..962192ec8ee8
>>>>>> --- /dev/null
>>>>>> +++ b/Documentation/index.rst
>>>>>> @@ -0,0 +1,30 @@
>>>>>> +LibCamera abstraction library
>>>
>>> Similarly here, you should write "libcamera". "libcamera library" seems a
>>> bit redundant to me. Other options could be "Linux Camera Library",
>>> "Linux Camera Support Library", "Linux Camera Framework", "Linux Camera
>>> Framework Library" (possibly without the "Linux" prefix, even though the
>>> project targets Linux only).
>>
>> Shortened to just libcamera
> 
> Works for me.
> 
>>>>>> +=============================
>>>>>> +
>>>>>> +Cameras are complex devices that need heavy hardware image processing
>>>>>> +operations. Control of the processing is based on advanced algorithms
>>>>>> that must +run on a programmable processor. This has traditionally been
>>>>>> implemented in a +dedicated MCU in the camera, but in embedded devices
>>>>>> algorithms have been moved +to the main CPU to save cost. Blurring the
>>>>>> boundary between camera devices and +Linux often left the user with no
>>>>>> other option than a vendor-specific +closed-source solution.
>>>>>> +
>>>>>> +To address this problem the Linux media community has very recently
>>>>>> started +collaboration with the industry to develop a camera stack that
>>>>>> will be +open-source-friendly while still protecting vendor core IP.
>>>>>> libcamera was born +out of that collaboration and will offer modern
>>>>>> camera support to Linux-based +systems, including traditional Linux
>>>>>> distributions, ChromeOS and Android. +
>>>>>> +
>>>>>> +.. toctree::
>>>>>> +   :maxdepth: 2
>>>>>> +   :caption: Contents:
>>>>>> +
>>>>>> +   hacking
>>>>>> +
>>>>>> +
>>>>>> +Indices and tables
>>>>>> +==================
>>>>>> +
>>>>>> +* :ref:`genindex`
>>>>>> +* :ref:`search`
>>>>>> diff --git a/Documentation/meson.build b/Documentation/meson.build
>>>>>> new file mode 100644
>>>>>> index 000000000000..5ab04479d3fb
>>>>>> --- /dev/null
>>>>>> +++ b/Documentation/meson.build
>>>>>> @@ -0,0 +1,20 @@
>>>>>> +sphinx = find_program('sphinx-build-3', required: false)
>>>>>> +if not sphinx.found()
>>>>>> +    sphinx = find_program('sphinx-build', required: false)
>>>>>> +endif
>>>>>> +
>>>>>> +if sphinx.found()
>>>>>> +    docs_sources = [
>>>>>> +	'hacking.rst',
>>>>>> +	'index.rst',
>>>>>> +    ]
>>>>>> +
>>>>>> +    custom_target('en user documentation',
>>>
>>> What does this stand for ? English user documentation ? End user
>>> documentation
>>
>> English.
>>
>> Perhaps it's unlikely that we'll do translations, but the sample
>> meson.build I saw utilised this.
>>
>> I'll drop it (references to en), it's unlikely to happen, and we can
>> always indent if needed then.
>>
>> This particular string is simply the text shown by ninja in this compile
>> stage.
> 
> Let's just go for "documentation" for now then. I don't think we'll translate 
> it any time soon :-)
> 
> How are custom targets invoked with ninja ? You're building the documentation 
> by default, and I think that's the right thing to do in order to catch errors, 
> but what if the target wasn't build_by_default, how would it be invoked ?

Currently, I don't know. It's not particularly clear how to make custom
named targets. As far as I can tell - the ninja targets are simply the
output paths.

It can go on a todo-list for things to learn and develop next.

Patches welcome :-)


>>> ?
>>>
>>>>>> +		  command: [sphinx, '-W', '-b', 'html', 
> meson.current_source_dir(),
>>>>>> '@OUTPUT@'],
>>>>>> +		  input: docs_sources,
>>>>>> +		  output: 'en',

in fact, I think this output: 'en', should be replaced by 'html' as we
are generating HTML documentation in this build target.
Perhaps other build targets would generate 'man', 'pdf' etc, which may
not need to be their own subdirectories, if they generate a single file
- but html does feel like it needs it's own place.



>>>>>> +		  build_by_default: true)
>>>>>> +
>>>>>> +    install_subdir(meson.current_build_dir() + '/en',
>>>>>> +		  install_dir: 'share/doc/libcamera-@0@/
> user'.format(api_version))
>>>
>>> Why the user/ directory ?
>>
>> It was from the example integration. I can remove.
>>
>> I think it was distinguishing between documentation for a user utilising
>> the library API, and a separate set for developing on the library.
>>
>> Do you think we should have a similar split of documentation?
>> Or all in one?
> 
> I would go for all in one to start with. If we need to split later we'll do 
> it.

Agreed, I'll clean up and remove the layer.


Updated patch sent.


>>>>>> +endif
>>>
>>> [snip]
>