]> granicus.if.org Git - icinga2/commitdiff
Remove sphinx/pandoc, ship markdown docs only
authorMichael Friedrich <michael.friedrich@gmail.com>
Fri, 13 Jun 2014 18:29:33 +0000 (20:29 +0200)
committerMichael Friedrich <michael.friedrich@gmail.com>
Fri, 13 Jun 2014 18:29:33 +0000 (20:29 +0200)
refs #6481
refs #5774

debian/control
debian/icinga2-doc.doc-base [deleted file]
debian/icinga2-doc.install
doc/CMakeLists.txt
doc/conf.py [deleted file]
doc/mkdoc.sh [deleted file]

index 4d49ab0749762ea64dd0d6555af0b59075ec701d..34c85103f5e844210ac47c75b8a9fa0745cd83e3 100644 (file)
@@ -21,10 +21,7 @@ Build-Depends:
     libmysqlclient-dev,
     libpq-dev,
     libssl-dev,
-    po-debconf,
-    python-dev,
-    pandoc,
-    python-sphinx
+    po-debconf
 Standards-Version: 3.9.5
 Homepage: http://www.icinga.org
 
diff --git a/debian/icinga2-doc.doc-base b/debian/icinga2-doc.doc-base
deleted file mode 100644 (file)
index 170ab7e..0000000
+++ /dev/null
@@ -1,10 +0,0 @@
-Document: icinga2
-Title: Icinga 2 Documentation
-Author: Icinga Developement Team
-Abstract: Icinga 2 user and administrator's documentation
-Section: Network/Monitoring
-
-Format: HTML
-Index: /usr/share/doc/icinga2/htdocs/index.html
-Files: /usr/share/doc/icinga2/htdocs/*.html
-
index 519ebc026e04e6a9f2d908ea0e46a3ff95afb7b2..aa32af127b14fff5efafb426a64fdb16bc8bbdb8 100644 (file)
@@ -1 +1 @@
-usr/share/doc/icinga2/htdocs
+usr/share/doc/icinga2/markdown
index 789b601907edd9f3321848f986f715333aa90195..cf209421f0614606ebb4bfbed24d852ae1a11523 100644 (file)
 file(GLOB DOCSRCS "*.md")
 
 if(UNIX OR CYGWIN)
-  add_custom_command(
-    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/htdocs/index.html
-    COMMAND ./mkdoc.sh
-    ARGS ${CMAKE_CURRENT_BINARY_DIR}
-    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-    DEPENDS ${DOCSRCS}
-  )
-
-  install(
-    DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/htdocs
-    DESTINATION ${CMAKE_INSTALL_DOCDIR}
-  )
-
-  add_custom_target(index-html ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/htdocs/index.html)
-
   install(
     FILES icinga2.8
     DESTINATION ${CMAKE_INSTALL_MANDIR}/man8
   )
 endif()
 
-# pandoc is not available or working everywhere, so install the unprocessed markdown files too
 install(
   FILES ${DOCSRCS}
   DESTINATION ${CMAKE_INSTALL_DOCDIR}/markdown
 )
-
-if(UNIX OR CYGWIN)
-  # maybe someone wants to process his own doc files after installing current pandoc/sphinx
-  install(
-    FILES conf.py mkdoc.sh
-    DESTINATION ${CMAKE_INSTALL_DOCDIR}/markdown
-  )
-endif()
diff --git a/doc/conf.py b/doc/conf.py
deleted file mode 100644 (file)
index 02c0315..0000000
+++ /dev/null
@@ -1,247 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-#
-# icinga2 documentation build configuration file, created by
-# sphinx-quickstart on Sun Apr  6 12:22:25 2014.
-#
-# 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, re
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
-
-# -- 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 = []
-
-# 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 = 'Icinga 2'
-copyright = '2014, Icinga Development Team <info@icinga.org>'
-
-_specfp = open('../icinga2.spec')
-_version = re.search("^Version:\\s+(.*)$", _specfp.read(), re.MULTILINE).group(1)
-_specfp.close()
-
-# 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 = _version
-# The full version, including alpha/beta/rc tags.
-release = _version
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = []
-
-# 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 = 'default'
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
-#html_theme_options = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
-
-# The name for this set of Sphinx documents.  If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = 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 = []
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_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 = True
-
-# 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 = 'icinga2doc'
-
-
-# -- 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': '',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
-latex_documents = [
-  ('index', 'icinga2.tex', 'icinga2 Documentation',
-   'Gunnar Beutner', 'manual'),
-]
-
-# 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
-
-
-# -- Options for manual page output --------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
-    ('index', 'icinga2', 'icinga2 Documentation',
-     ['Gunnar Beutner'], 1)
-]
-
-# If true, show URL addresses after external links.
-#man_show_urls = False
-
-
-# -- 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 = [
-  ('index', 'icinga2', 'Icinga 2 Documentation',
-   'Icinga Development Team', 'icinga2', 'The Icinga 2 network monitoring application',
-   'Miscellaneous'),
-]
-
-# Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
-
-# If false, no module index is generated.
-#texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
diff --git a/doc/mkdoc.sh b/doc/mkdoc.sh
deleted file mode 100755 (executable)
index 208219f..0000000
+++ /dev/null
@@ -1,53 +0,0 @@
-#!/bin/sh
-cd $(dirname -- $0)
-
-if [ -z "$1" ]; then
-  echo "Syntax: $0 <build-dir>"
-  exit 1
-fi
-
-BUILDDIR="$1"
-
-mkdir -p $BUILDDIR/htdocs
-
-if ! which pandoc; then
-  echo "Please install pandoc to build the documentation files." > $BUILDDIR/htdocs/index.html
-  exit 0
-fi
-
-if ! which sphinx-build; then
-  echo "Please install sphinx-build to build the documentation files." > $BUILDDIR/htdocs/index.html
-  exit 0
-fi
-
-BUILDDIR="$1"
-
-echo "Build dir: $BUILDDIR"
-
-rm -f index.rst
-cat > index.rst <<RST
-Icinga 2
-========
-
-.. toctree::
-RST
-
-for chapter in $(seq 1 100); do
-  files=$chapter*.md
-  count=0
-  for file in $files; do
-    if [ -f $file ]; then
-      count=$(expr $count + 1)
-    fi
-  done
-  if [ $count = 0 ]; then
-    break
-  fi
-  echo "    chapter-$chapter" >> index.rst
-  for file in $files; do
-    cat $file
-    echo
-  done | sed 's/<a id=".*"><\/a>//' | pandoc -f markdown_phpextra -t rst > chapter-$chapter.rst
-done
-
-sphinx-build -b html -d $BUILDDIR/doctrees . $BUILDDIR/htdocs