[PATCH 4 of 5] (issue89) Add sphinx integration for the build system
Wald Commits
scm-commit at wald.intevation.org
Fri Aug 22 17:17:01 CEST 2014
# HG changeset patch
# User Andre Heinecke <andre.heinecke at intevation.de>
# Date 1408720016 -7200
# Node ID af27328bea9d78a0fc32c5ab6bc5366b035e1291
# Parent 57371f2e8daecd51fc600dba22acaa8158e1684c
(issue89) Add sphinx integration for the build system.
diff -r 57371f2e8dae -r af27328bea9d CMakeLists.txt
--- a/CMakeLists.txt Fri Aug 22 16:20:25 2014 +0200
+++ b/CMakeLists.txt Fri Aug 22 17:06:56 2014 +0200
@@ -132,6 +132,14 @@
configure_file (doc/Doxyfile.in doc/Doxyfile)
add_subdirectory(doc)
+find_package(Sphinx)
+
+if (NOT SPHINX_FOUND)
+ message (STATUS "WARNING could not find sphinx (Package python-sphinx). Manuals will not be built.")
+else()
+ add_subdirectory(manuals)
+endif()
+
# Configure packaging script for testing
configure_file (packaging/win-createpackage.sh.in packaging/win-createpackage.sh @ONLY)
configure_file (packaging/create-dist-package.sh.in packaging/create-dist-package.sh @ONLY)
diff -r 57371f2e8dae -r af27328bea9d cmake/FindSphinx.cmake
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/cmake/FindSphinx.cmake Fri Aug 22 17:06:56 2014 +0200
@@ -0,0 +1,14 @@
+find_program(SPHINX_EXECUTABLE NAMES sphinx-build
+ HINTS
+ $ENV{SPHINX_DIR}
+ PATH_SUFFIXES bin
+ DOC "Sphinx documentation generator"
+)
+
+include(FindPackageHandleStandardArgs)
+
+find_package_handle_standard_args(Sphinx DEFAULT_MSG
+ SPHINX_EXECUTABLE
+)
+
+mark_as_advanced(SPHINX_EXECUTABLE)
diff -r 57371f2e8dae -r af27328bea9d manuals/CMakeLists.txt
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/manuals/CMakeLists.txt Fri Aug 22 17:06:56 2014 +0200
@@ -0,0 +1,60 @@
+# Copyright (C) 2014 by Bundesamt für Sicherheit in der Informationstechnik
+# Software engineering by Intevation GmbH
+#
+# This file is Free Software under the GNU GPL (v>=2)
+# and comes with ABSOLUTELY NO WARRANTY!
+# See LICENSE.txt for details.
+
+if(NOT DEFINED SPHINX_THEME)
+ set(SPHINX_THEME better)
+endif()
+
+if(NOT DEFINED SPHINX_THEME_DIR)
+ set(SPHINX_THEME_DIR "${CMAKE_CURRENT_SOURCE_DIR}/theme")
+endif()
+
+set(ADMIN_MANUAL_IN "${CMAKE_CURRENT_SOURCE_DIR}/admin-manual")
+set(ADMIN_MANUAL_OUT "${CMAKE_CURRENT_BINARY_DIR}/admin-manual")
+set(HELP_MANUAL_IN "${CMAKE_CURRENT_SOURCE_DIR}/help-manual")
+set(HELP_MANUAL_OUT "${CMAKE_CURRENT_BINARY_DIR}/help-manual")
+
+
+# configured documentation tools and intermediate build results
+set(BINARY_BUILD_DIR_ADMIN "${CMAKE_CURRENT_BINARY_DIR}/_build-admin")
+set(BINARY_BUILD_DIR_HELP "${CMAKE_CURRENT_BINARY_DIR}/_build-help")
+
+# Sphinx cache with pickled ReST documents
+set(SPHINX_CACHE_DIR_ADMIN "${CMAKE_CURRENT_BINARY_DIR}/_doctrees-admin")
+set(SPHINX_CACHE_DIR_HELP "${CMAKE_CURRENT_BINARY_DIR}/_doctrees-help")
+
+# HTML output directory
+set(SPHINX_HTML_DIR_ADMIN "${ADMIN_MANUAL_OUT}/html")
+set(SPHINX_HTML_DIR_HELP "${HELP_MANUAL_OUT}/html")
+
+configure_file(
+ "${ADMIN_MANUAL_IN}/conf.py.in"
+ "${BINARY_BUILD_DIR_ADMIN}/conf.py"
+ @ONLY)
+
+configure_file(
+ "${HELP_MANUAL_IN}/conf.py.in"
+ "${BINARY_BUILD_DIR_HELP}/conf.py"
+ @ONLY)
+
+add_custom_target(admin_manual ALL
+ ${SPHINX_EXECUTABLE}
+ -q -b html
+ -c "${BINARY_BUILD_DIR_ADMIN}"
+ -d "${SPHINX_CACHE_DIR_ADMIN}"
+ "${ADMIN_MANUAL_IN}"
+ "${SPHINX_HTML_DIR_ADMIN}"
+ COMMENT "Building HTML Admin documentation with Sphinx")
+
+add_custom_target(help_manual ALL
+ ${SPHINX_EXECUTABLE}
+ -q -b html
+ -c "${BINARY_BUILD_DIR_HELP}"
+ -d "${SPHINX_CACHE_DIR_HELP}"
+ "${HELP_MANUAL_IN}"
+ "${SPHINX_HTML_DIR_HELP}"
+ COMMENT "Building HTML Help with Sphinx")
diff -r 57371f2e8dae -r af27328bea9d manuals/README.txt
--- a/manuals/README.txt Fri Aug 22 16:20:25 2014 +0200
+++ b/manuals/README.txt Fri Aug 22 17:06:56 2014 +0200
@@ -1,5 +1,11 @@
-How to build TrustBridge documentation?
-=======================================
+TrustBridge documentation
+=========================
+
+The TrustBridge documentation should be build automatically by the
+default target in cmake if sphinx is found.
+
+How to build TrustBridge documentation manually
+===============================================
The TrustBridge documentation based on Sphinx <http://sphinx-doc.org/>.
Please install the requirements before you build the documentation.
diff -r 57371f2e8dae -r af27328bea9d manuals/admin-manual/conf.py.in
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/manuals/admin-manual/conf.py.in Fri Aug 22 17:06:56 2014 +0200
@@ -0,0 +1,239 @@
+# -*- coding: utf-8 -*-
+#
+# Dokumentationsvorlage documentation build configuration file, created by
+# sphinx-quickstart on Fri Dec 14 12:07:59 2012.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# 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.
+#sys.path.insert(0, os.path.abspath('extensions'))
+
+# -- 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 of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'TrustBridge-Hilfe'
+copyright = u'2014, BSI'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '@HG_REVISION_TAG@'
+# The full version, including alpha/beta/rc tags.
+release = '@PROJECT_VERSION@'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+language = 'de'
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- 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_path = ['@SPHINX_THEME_DIR@']
+html_theme = '@SPHINX_THEME@'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+html_theme_options = {
+ 'linktotheme': False,
+ 'cssfiles': ['_static/extra-style.css'],
+}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+html_title = 'TrustBridge-Verwaltung Hilfe'
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+html_short_title = 'Home'
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+html_sidebars = {
+ '**': ['globaltoc.html', 'searchbox.html'],
+}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+html_show_sphinx = False
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+# htmlhelp_basename = ''
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+'papersize': 'a4paper,oneside',
+
+# The font size ('10pt', '11pt' or '12pt').
+'pointsize': '11pt',
+
+# Additional stuff for the LaTeX preamble.
+'preamble':
+ '\\usepackage{colortbl} '\
+ '\\usepackage{booktabs} '\
+ '\\usepackage{tabularx} '\
+ '\\newcommand{\\projecttitle}{} '\
+ '\\newcommand{\\documenttype}{TrustBridge-Verwaltungsanwendung} '\
+ '\\newcommand{\\documentdate}{12. August 2014} '\
+ '\\newcommand{\\documentversion}{Version 0.1} '\
+ '\\newcommand{\\customer}{BSI} '\
+ '',
+
+'babel': '\usepackage[ngerman]{babel}',
+'fncychap' : '',
+
+'maketitle':
+ # Titelseite
+ '\\includegraphics[height=2cm]{brieflogo-neu.png} \\\\[2.5cm] '\
+ '{\\sffamily\\bfseries\\large \\projecttitle \\\\[0.5cm] '\
+ '\\huge \\documenttype \\\\[2.5cm]'\
+ '\\small \\documentdate, \\documentversion \\\\[2.5cm]'\
+ '\\sffamily\\bfseries\\small '\
+ 'Autor: Intevation GmbH\\\\[1.0cm] '\
+ '} '\
+ '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'TrustBridge-Verwaltungsanwendung.tex', u'TrustBridge-Verwaltungsanwendung',
+ u'Intevation GmbH', 'manual'),
+]
+
+latex_docclass = { 'manual': 'scrreprt', }
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
diff -r 57371f2e8dae -r af27328bea9d manuals/help-manual/conf.py.in
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/manuals/help-manual/conf.py.in Fri Aug 22 17:06:56 2014 +0200
@@ -0,0 +1,239 @@
+# -*- coding: utf-8 -*-
+#
+# Dokumentationsvorlage documentation build configuration file, created by
+# sphinx-quickstart on Fri Dec 14 12:07:59 2012.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# 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.
+#sys.path.insert(0, os.path.abspath('extensions'))
+
+# -- 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 of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'TrustBridge-Hilfe'
+copyright = u'2014, BSI'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '@HG_REVISION_TAG@'
+# The full version, including alpha/beta/rc tags.
+release = '@PROJECT_VERSION@'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+language = 'de'
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- 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_path = ['@SPHINX_THEME_DIR@']
+html_theme = '@SPHINX_THEME@'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+html_theme_options = {
+ 'linktotheme': False,
+ 'cssfiles': ['_static/extra-style.css'],
+}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+html_title = 'TrustBridge-Hilfe'
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+html_short_title = 'Home'
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+html_sidebars = {
+ '**': ['globaltoc.html', 'searchbox.html'],
+}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+html_show_sphinx = False
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+# htmlhelp_basename = ''
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+'papersize': 'a4paper,oneside',
+
+# The font size ('10pt', '11pt' or '12pt').
+'pointsize': '11pt',
+
+# Additional stuff for the LaTeX preamble.
+'preamble':
+ '\\usepackage{colortbl} '\
+ '\\usepackage{booktabs} '\
+ '\\usepackage{tabularx} '\
+ '\\newcommand{\\projecttitle}{} '\
+ '\\newcommand{\\documenttype}{TrustBridge-Benutzerdokumentation} '\
+ '\\newcommand{\\documentdate}{12. August 2014} '\
+ '\\newcommand{\\documentversion}{Version 0.1} '\
+ '\\newcommand{\\customer}{BSI} '\
+ '',
+
+'babel': '\usepackage[ngerman]{babel}',
+'fncychap' : '',
+
+'maketitle':
+ # Titelseite
+ '\\includegraphics[height=2cm]{brieflogo-neu.png} \\\\[2.5cm] '\
+ '{\\sffamily\\bfseries\\large \\projecttitle \\\\[0.5cm] '\
+ '\\huge \\documenttype \\\\[2.5cm]'\
+ '\\small \\documentdate, \\documentversion \\\\[2.5cm]'\
+ '\\sffamily\\bfseries\\small '\
+ 'Autor: Intevation GmbH\\\\[1.0cm] '\
+ '} '\
+ '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'TrustBridge-Hilfe.tex', u'TrustBridge-Hilfe',
+ u'Intevation GmbH', 'manual'),
+]
+
+latex_docclass = { 'manual': 'scrreprt', }
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
More information about the Trustbridge-commits
mailing list