[1/4] Documentation: Remove unneeded options from Sphinx configuration
diff mbox series

Message ID 20250727015720.6867-2-laurent.pinchart@ideasonboard.com
State Superseded
Headers show
Series
  • Documentation: Use doxylink to generate Sphinx-to-Doxygen links
Related show

Commit Message

Laurent Pinchart July 27, 2025, 1:57 a.m. UTC
libcamera only generates HTML documentation. Drop the unused
configuration options for other output formats, as well as unneeded
entries in the exclude patterns.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 Documentation/conf.py | 78 -------------------------------------------
 1 file changed, 78 deletions(-)

Comments

Stefan Klug July 29, 2025, 4:16 p.m. UTC | #1
Hi Laurent,

Thank you for the patch.

Quoting Laurent Pinchart (2025-07-27 03:57:11)
> libcamera only generates HTML documentation. Drop the unused
> configuration options for other output formats, as well as unneeded
> entries in the exclude patterns.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Less clutter is always good and I don't see a negative side effect.
So

Reviewed-by: Stefan Klug <stefan.klug@ideasonboard.com> 

Regards,
Stefan

> ---
>  Documentation/conf.py | 78 -------------------------------------------
>  1 file changed, 78 deletions(-)
> 
> diff --git a/Documentation/conf.py b/Documentation/conf.py
> index 089f114c11d5..7d05fc9abcd3 100644
> --- a/Documentation/conf.py
> +++ b/Documentation/conf.py
> @@ -65,9 +65,6 @@ language = 'en'
>  # 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',
>      'documentation-contents.rst',
>  ]
>  
> @@ -103,78 +100,3 @@ html_static_path = []
>  # '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',
> -     author, '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']
> -- 
> Regards,
> 
> Laurent Pinchart
>

Patch
diff mbox series

diff --git a/Documentation/conf.py b/Documentation/conf.py
index 089f114c11d5..7d05fc9abcd3 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -65,9 +65,6 @@  language = 'en'
 # 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',
     'documentation-contents.rst',
 ]
 
@@ -103,78 +100,3 @@  html_static_path = []
 # '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',
-     author, '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']