[PATCH] Added first draft of manuals for TrustBridge and TrustBridge Admin (using Sphinx)
Wald Commits
scm-commit at wald.intevation.org
Wed Aug 13 14:49:54 CEST 2014
# HG changeset patch
# User Emanuel Schuetze <emanuel at intevation.de>
# Date 1407934165 -7200
# Node ID b5a49960d5cb97bd886e6b15602ecbda742ec143
# Parent f5a48c228e9b2f980f7351e374f6c87ba215f643
Added first draft of manuals for TrustBridge and TrustBridge Admin (using Sphinx).
diff -r f5a48c228e9b -r b5a49960d5cb manuals/README.txt
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/manuals/README.txt Wed Aug 13 14:49:25 2014 +0200
@@ -0,0 +1,24 @@
+How to build TrustBridge documentation?
+=======================================
+
+The TrustBridge documentation based on Sphinx <http://sphinx-doc.org/>.
+Please install the requirements before you build the documentation.
+
+ $ virtualenv .venv
+ $ . .venv/bin/activate
+ (.venv) pip install -r requirements.txt
+
+
+Build TrustBridge help pages:
+ (.venv) cd help-manual
+ (.venv) make html
+
+ => Open HTML output: _build/html/index.html
+
+
+Build TrustBridge Admin help pages:
+ (.venv) cd admin-manual
+ (.venv) make html
+
+ => Open HTML output: _build/html/index.html
+
diff -r f5a48c228e9b -r b5a49960d5cb manuals/admin-manual/Makefile
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/manuals/admin-manual/Makefile Wed Aug 13 14:49:25 2014 +0200
@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Dokumentationsvorlage.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Dokumentationsvorlage.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/Dokumentationsvorlage"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Dokumentationsvorlage"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
diff -r f5a48c228e9b -r b5a49960d5cb manuals/admin-manual/_static/extra-style.css
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/manuals/admin-manual/_static/extra-style.css Wed Aug 13 14:49:25 2014 +0200
@@ -0,0 +1,9 @@
+.figure img {
+ border: 1px solid lightgrey;
+ margin-bottom: 10px;
+ padding: 4px;
+}
+.figure .caption {
+ margin-top: 0px;
+ margin-bottom: 20px;
+}
diff -r f5a48c228e9b -r b5a49960d5cb manuals/admin-manual/_templates/searchbox.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/manuals/admin-manual/_templates/searchbox.html Wed Aug 13 14:49:25 2014 +0200
@@ -0,0 +1,22 @@
+{#
+ basic/searchbox.html
+ ~~~~~~~~~~~~~~~~~~~~
+
+ Sphinx sidebar template: quick search box.
+
+ :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
+ :license: BSD, see LICENSE for details.
+#}
+{%- if pagename != "search" and builder != "singlehtml" %}
+<div id="searchbox" style="display: none">
+ <h3>{{ _('Quick search') }}</h3>
+ <form class="search" action="{{ pathto('search') }}" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="{{ _('Go') }}" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+<p></p>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+{%- endif %}
diff -r f5a48c228e9b -r b5a49960d5cb manuals/admin-manual/bedienung.rst
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/manuals/admin-manual/bedienung.rst Wed Aug 13 14:49:25 2014 +0200
@@ -0,0 +1,7 @@
+Die grafische Oberfläche
+========================
+
+
+Die **TrustBridge-Verwaltungsanwendung** ...
+
+TODO: Screenshot
diff -r f5a48c228e9b -r b5a49960d5cb manuals/admin-manual/conf.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/manuals/admin-manual/conf.py Wed Aug 13 14:49:25 2014 +0200
@@ -0,0 +1,240 @@
+# -*- 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 = '1.0'
+# The full version, including alpha/beta/rc tags.
+release = '1.0'
+
+# 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.
+from better import better_theme_path
+html_theme_path = [better_theme_path]
+html_theme = 'better'
+
+# 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 f5a48c228e9b -r b5a49960d5cb manuals/admin-manual/index.rst
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/manuals/admin-manual/index.rst Wed Aug 13 14:49:25 2014 +0200
@@ -0,0 +1,52 @@
+Was ist TrustBridge?
+====================
+
+TrustBridge ist eine Anwendung vom `Bundesamt für Sicherheit in der Informationstechnik (BSI) <https://bsi.bund.de>`_ für die Verbreitung von empfohlenen Wurzelzertifikaten.
+
+TrustBridge macht es Nutzern einfacher, Wurzelzertifikate für eine
+X.509-basierende, öffentliche Zertifikatsinfrastruktur (PKI)
+einzuspielen und aktuell zu halten. TrustBridge verteilt
+Wurzelzertifikate, welche von den Betriebssystemen und Webbrowsern
+nicht mitgeliefert werden. Existierende Zertifikate, die korrumpiert oder missbraucht wurden, können über eine Deinstallations-Empfehlung von TrustBridge entfernt werden.
+Dabei ist unerheblich, ob die Zertifikate auf der Anwenderebene
+vorher bereits installiert waren.
+
+**Wurzelzertifikate** sind die Basis einer PKI zur Feststellung der
+Authentizität des Kommunikationspartners und der Integrität seiner
+Nachrichten für verschiedene Anwendungen -- insbesondere bei der
+Übertragung über unsichere Kommunikationskanäle, wie dem Internet.
+
+Ein Wurzel- oder auch "Root"-Zertifikat dient als Vertrauensanker
+("Trust Anchor") für alle darunter hängenden Zertifikate. Unterhalb
+der Wurzel folgt eine Sicherheitskette ("Trust Chain") von ein oder
+mehreren Zwischenzertifikaten der Zertifizierungsstellen, gefolgt von
+den ausgestellten Zertifikaten für die Anwendungen. Die Zertifikate
+sichern per Public-Key-Kryptoverfahren nach dem X.509-v3 Standard
+beispielsweise TLS-Verbindungen von Webbrowser zu Webserver (HTTPS)
+oder E-Mail-Klient zu E-Mail-Server (IMAPS). Ein weiteres Beispiel ist
+die Ende-zu-Ende Absicherung von E-Mail per S/MIME-Standard.
+
+
+Über diese Hilfe
+================
+Diese Hilfe unterstützt Sie bei der Bedienung der TrustBridge-Verwaltungsanwendung.
+Die Hilfeseiten im Überblick:
+
+.. toctree::
+ :maxdepth: 2
+
+ installation
+ bedienung
+
+
+Impressum
+=========
+
+Copyright 2014 Die Rechte liegen beim `Bundesamt für Sicherheit in der Informationstechnik (BSI) <https://bsi.bund.de>`_.
+
+TrustBridge wurde von den Unternehmen `Intevation GmbH
+<http://www.intevation.de>`_ und `DN-Systems GmbH
+<http://www.dn-systems.com>`_ entwickelt, im Auftrag vom BSI.
+
+Diese TrustBridge-Hilfe ist unter der `Creative Commons CC BY-SA 3.0
+<http://creativecommons.org/licenses/by-sa/3.0/>`_ lizensiert.
diff -r f5a48c228e9b -r b5a49960d5cb manuals/admin-manual/installation.rst
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/manuals/admin-manual/installation.rst Wed Aug 13 14:49:25 2014 +0200
@@ -0,0 +1,9 @@
+Installation
+============
+
+Die TrustBridge-Verwaltungsanwendung läuft unter Windows und GNU/Linux.
+Offiziell unterstützt und geprüft sind Windows 7 und Ubuntu 14.04
+(jeweils 64 Bit).
+
+
+TODO: Systemvoraussetzung, Windows, Ubuntu
diff -r f5a48c228e9b -r b5a49960d5cb manuals/help-manual/.conf.py.swp
Binary file manuals/help-manual/.conf.py.swp has changed
diff -r f5a48c228e9b -r b5a49960d5cb manuals/help-manual/Makefile
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/manuals/help-manual/Makefile Wed Aug 13 14:49:25 2014 +0200
@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Dokumentationsvorlage.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Dokumentationsvorlage.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/Dokumentationsvorlage"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Dokumentationsvorlage"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
diff -r f5a48c228e9b -r b5a49960d5cb manuals/help-manual/_static/extra-style.css
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/manuals/help-manual/_static/extra-style.css Wed Aug 13 14:49:25 2014 +0200
@@ -0,0 +1,9 @@
+.figure img {
+ border: 1px solid lightgrey;
+ margin-bottom: 10px;
+ padding: 4px;
+}
+.figure .caption {
+ margin-top: 0px;
+ margin-bottom: 20px;
+}
diff -r f5a48c228e9b -r b5a49960d5cb manuals/help-manual/_static/stores.png
Binary file manuals/help-manual/_static/stores.png has changed
diff -r f5a48c228e9b -r b5a49960d5cb manuals/help-manual/_templates/searchbox.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/manuals/help-manual/_templates/searchbox.html Wed Aug 13 14:49:25 2014 +0200
@@ -0,0 +1,22 @@
+{#
+ basic/searchbox.html
+ ~~~~~~~~~~~~~~~~~~~~
+
+ Sphinx sidebar template: quick search box.
+
+ :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
+ :license: BSD, see LICENSE for details.
+#}
+{%- if pagename != "search" and builder != "singlehtml" %}
+<div id="searchbox" style="display: none">
+ <h3>{{ _('Quick search') }}</h3>
+ <form class="search" action="{{ pathto('search') }}" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="{{ _('Go') }}" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+<p></p>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+{%- endif %}
diff -r f5a48c228e9b -r b5a49960d5cb manuals/help-manual/bedienung.rst
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/manuals/help-manual/bedienung.rst Wed Aug 13 14:49:25 2014 +0200
@@ -0,0 +1,12 @@
+Die grafische Oberfläche
+========================
+
+
+Die **TrustBridge-Oberfläche** gliedert sich in 3 Seiten, die über die
+großen Schaltflächen an der linken Seite aufgerufen werden können:
+
+- **Neue Empfehlungen:** Alle verfügbaren Aktualisierungen und Änderungen werden hier bestätigt und installiert.
+- **Empfohlene Wurzelzertifikate:** Alle Wurzelzertifikate, die TrustBridge zur Installation vorgeschlagen hat.
+- **Abgeratene Wurzelzertifikate:** Alle Wurzelzertifikate, die TrustBridge zur Deinstallation empfohlen hat.
+
+TODO: Screenshot
diff -r f5a48c228e9b -r b5a49960d5cb manuals/help-manual/conf.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/manuals/help-manual/conf.py Wed Aug 13 14:49:25 2014 +0200
@@ -0,0 +1,240 @@
+# -*- 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 = '1.0'
+# The full version, including alpha/beta/rc tags.
+release = '1.0'
+
+# 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.
+from better import better_theme_path
+html_theme_path = [better_theme_path]
+html_theme = 'better'
+
+# 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
diff -r f5a48c228e9b -r b5a49960d5cb manuals/help-manual/index.rst
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/manuals/help-manual/index.rst Wed Aug 13 14:49:25 2014 +0200
@@ -0,0 +1,54 @@
+Was ist TrustBridge?
+====================
+
+TrustBridge ist eine Anwendung vom `Bundesamt für Sicherheit in der Informationstechnik (BSI) <https://bsi.bund.de>`_ für die Verbreitung von empfohlenen Wurzelzertifikaten.
+
+TrustBridge macht es Nutzern einfacher, Wurzelzertifikate für eine
+X.509-basierende, öffentliche Zertifikatsinfrastruktur (PKI)
+einzuspielen und aktuell zu halten. TrustBridge verteilt
+Wurzelzertifikate, welche von den Betriebssystemen und Webbrowsern
+nicht mitgeliefert werden. Existierende Zertifikate, die korrumpiert oder missbraucht wurden, können über eine Deinstallations-Empfehlung von TrustBridge entfernt werden.
+Dabei ist unerheblich, ob die Zertifikate auf der Anwenderebene
+vorher bereits installiert waren.
+
+**Wurzelzertifikate** sind die Basis einer PKI zur Feststellung der
+Authentizität des Kommunikationspartners und der Integrität seiner
+Nachrichten für verschiedene Anwendungen -- insbesondere bei der
+Übertragung über unsichere Kommunikationskanäle, wie dem Internet.
+
+Ein Wurzel- oder auch "Root"-Zertifikat dient als Vertrauensanker
+("Trust Anchor") für alle darunter hängenden Zertifikate. Unterhalb
+der Wurzel folgt eine Sicherheitskette ("Trust Chain") von ein oder
+mehreren Zwischenzertifikaten der Zertifizierungsstellen, gefolgt von
+den ausgestellten Zertifikaten für die Anwendungen. Die Zertifikate
+sichern per Public-Key-Kryptoverfahren nach dem X.509-v3 Standard
+beispielsweise TLS-Verbindungen von Webbrowser zu Webserver (HTTPS)
+oder E-Mail-Klient zu E-Mail-Server (IMAPS). Ein weiteres Beispiel ist
+die Ende-zu-Ende Absicherung von E-Mail per S/MIME-Standard.
+
+
+Über diese Hilfe
+================
+Diese Hilfe unterstützt Sie bei der Bedienung von TrustBridge sowie
+vermittelt Ihnen ein beseres Verständnis was die Anwendung macht und
+wofür das gut ist. Die Hilfeseiten im Überblick:
+
+.. toctree::
+ :maxdepth: 2
+
+ installation
+ bedienung
+ konzept
+
+
+Impressum
+=========
+
+Copyright 2014 Die Rechte liegen beim `Bundesamt für Sicherheit in der Informationstechnik (BSI) <https://bsi.bund.de>`_.
+
+TrustBridge wurde von den Unternehmen `Intevation GmbH
+<http://www.intevation.de>`_ und `DN-Systems GmbH
+<http://www.dn-systems.com>`_ entwickelt, im Auftrag vom BSI.
+
+Diese TrustBridge-Hilfe ist unter der `Creative Commons CC BY-SA 3.0
+<http://creativecommons.org/licenses/by-sa/3.0/>`_ lizensiert.
diff -r f5a48c228e9b -r b5a49960d5cb manuals/help-manual/installation.rst
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/manuals/help-manual/installation.rst Wed Aug 13 14:49:25 2014 +0200
@@ -0,0 +1,23 @@
+Installation
+============
+
+TrustBridge bietet Installationspakete für die Plattformen Windows und GNU/Linux.
+Offiziell unterstützt und geprüft sind Windows 7 und 8 sowie Ubuntu 14.04
+(jeweils 32 und 64 Bit).
+
+Weiterhin werden alle Anwendungen unterstützt, die auf die
+Zertifikatsspeicher zugreifen
+- Mozilla Firefox
+- Mozilla Thunderbird
+- Google Chrome / Chromium
+- MS Internet Explorer
+- MS Outlook
+
+
+Windows
+-------
+TODO: NSIS-Installer (signiert), systemweit vs. Einzelnutzer
+
+Ubuntu
+------
+TODO: Installatonsskript (signiert), systemweit vs. Einzelnutzer
diff -r f5a48c228e9b -r b5a49960d5cb manuals/help-manual/konzept.rst
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/manuals/help-manual/konzept.rst Wed Aug 13 14:49:25 2014 +0200
@@ -0,0 +1,39 @@
+=================
+Hintergrundwissen
+=================
+
+
+Zertifikatsspeicher
+===================
+
+Damit Zertifikaten in Anwendungen (wie z.B. Browser oder E-Mail-Klient)
+vertraut werden kann, müssen die zugehörigen Wurzelzertifikate in den passenden
+Zertifikatsspeichern des Systems installiert werden.
+TrustBridge übernimmt diese Zugriff auf die Zertifikatsspeicher.
+
+Es gibt zwei gängige Zertifikatsspeicher, die von TrustBridge und den meißten
+Anwendungen unterstützt
+werden:
+- der Mozilla NSS-Zertifikatsspeicher ("Network Security Services")
+und
+- der Windows-System-Zertifikatsspeicher.
+
+
+Chrome bzw. Chromium verwendet unter Windows den Windows-System-Speicher und unter
+Ubuntu den NSS-Zertifikatsspeicher. Die nachfolgende Abbildung veranschaulicht
+die verwendeten Zertifikatsspeicher unter Windows und GNU/Linux.
+
+.. figure:: _static/stores.png
+ :width: 100%
+ :alt: Übersicht der Zertifikatsspeicher
+
+ *Abbildung 1: Übersicht der Zertifikatsspeicher*
+
+Windows-Zertifikatsspeicher
+---------------------------
+
+
+
+
+Ablauf von Zertifikatsupdates
+=============================
diff -r f5a48c228e9b -r b5a49960d5cb manuals/requirements.txt
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/manuals/requirements.txt Wed Aug 13 14:49:25 2014 +0200
@@ -0,0 +1,2 @@
+Sphinx
+sphinx-better-theme
More information about the Trustbridge-commits
mailing list