python: build html docs using sphinx
Build instructions: make make DESTIDIR=/tmp/... install make DESTIDIR=/tmp/... sphinx-html sphinx-man sphinx-epub ...
This commit is contained in:
Zbigniew Jędrzejewski-Szmek
parent
d489071fb3
commit
9015fa646e
|
|
@ -3433,6 +3433,14 @@ BUILT_SOURCES += \
|
|||
src/python-systemd/id128-constants.h
|
||||
endif
|
||||
|
||||
if ENABLE_SPHINX
|
||||
PAPER = $(shell cat /etc/papersize 2>/dev/null || echo a4)
|
||||
SPHINXOPTS = -D latex_paper_size=$(PAPER)
|
||||
sphinx-%:
|
||||
$(AM_V_GEN)PYTHONPATH=$(DESTDIR)$(pyexecdir) $(SPHINX_BUILD) -b $* $(SPHINXOPTS) $(top_srcdir)/src/python-systemd/docs $(top_builddir)/man/python-systemd/
|
||||
$(AM_V_at)echo Output has been generated in $(abs_top_builddir)/man/python-systemd/
|
||||
endif
|
||||
|
||||
# ------------------------------------------------------------------------------
|
||||
SED_PROCESS = \
|
||||
$(AM_V_GEN)$(MKDIR_P) $(dir $@) && \
|
||||
|
|
|
|||
7
README
7
README
|
|
@ -81,6 +81,7 @@ REQUIREMENTS:
|
|||
gperf
|
||||
gtkdocize (optional)
|
||||
python (optional)
|
||||
sphinx (optional)
|
||||
|
||||
When systemd-hostnamed is used it is strongly recommended to
|
||||
install nss-myhostname to ensure that in a world of
|
||||
|
|
@ -93,6 +94,12 @@ REQUIREMENTS:
|
|||
please build D-Bus without systemd first, then build systemd,
|
||||
then rebuild D-Bus with systemd support.
|
||||
|
||||
To build HTML documentation for python-systemd using sphinx,
|
||||
please first install systemd (using 'make install'), and then
|
||||
invoke sphinx-build with 'make sphinx-<target>', with <target>
|
||||
being 'html' or 'latexpdf'. If using DESTDIR for installation,
|
||||
pass the same DESTDIR to 'make sphinx-html' invocation.
|
||||
|
||||
WARNINGS:
|
||||
systemd will warn you during boot if /etc/mtab is not a
|
||||
symlink to /proc/mounts. Please ensure that /etc/mtab is a
|
||||
|
|
|
|||
14
configure.ac
14
configure.ac
|
|
@ -180,6 +180,19 @@ AS_IF([test "x$with_python" != "xno"], [
|
|||
])
|
||||
AM_CONDITIONAL([HAVE_PYTHON_DEVEL], [test "$have_python_devel" = "yes"])
|
||||
|
||||
AC_ARG_ENABLE(sphinx, AS_HELP_STRING([--enable-sphinx],
|
||||
[use sphinx to build documentation for python-systemd]))
|
||||
AS_IF([test "x$enable_sphinx" = "xyes"], [
|
||||
AC_PATH_PROGS(SPHINX_BUILD, sphinx-build-${PYTHON_VERSION} sphinx-build)
|
||||
AS_IF([test -z "$SPHINX_BUILD"], [
|
||||
AC_MSG_ERROR([*** sphinx build requested, but sphinx-build not found])
|
||||
])
|
||||
AS_IF([test "x$have_python_devel" != "xyes"], [
|
||||
AC_MSG_ERROR([*** sphinx build requested, but python support not enabled])
|
||||
])
|
||||
])
|
||||
AM_CONDITIONAL(ENABLE_SPHINX, [test "x$enable_sphinx" = "xyes"])
|
||||
|
||||
# ------------------------------------------------------------------------------
|
||||
|
||||
AC_SEARCH_LIBS([mq_open], [rt], [], [AC_MSG_ERROR([*** POSIX RT library not found])])
|
||||
|
|
@ -902,6 +915,7 @@ AC_MSG_RESULT([
|
|||
Python Headers: ${have_python_devel}
|
||||
man pages: ${have_manpages}
|
||||
gtk-doc: ${enable_gtk_doc}
|
||||
sphinx documentation: ${enable_sphinx}
|
||||
Split /usr: ${enable_split_usr}
|
||||
SysV compatibility: ${SYSTEM_SYSV_COMPAT}
|
||||
|
||||
|
|
|
|||
|
|
@ -2,3 +2,4 @@
|
|||
/systemd.index.xml
|
||||
/systemd.unit.xml
|
||||
/*.[13578]
|
||||
/python-systemd/
|
||||
|
|
|
|||
|
|
@ -1 +1,2 @@
|
|||
/id128-constants.h
|
||||
*.py[oc]
|
||||
|
|
|
|||
|
|
@ -0,0 +1,288 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# python-systemd documentation build configuration file, created by
|
||||
# sphinx-quickstart on Sat Feb 9 13:49:42 2013.
|
||||
#
|
||||
# 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('.'))
|
||||
|
||||
# -- 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 = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
|
||||
|
||||
# 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'python-systemd'
|
||||
|
||||
# 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 = '197'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '197'
|
||||
|
||||
# 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 = False
|
||||
|
||||
# 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 = 'python-systemddoc'
|
||||
|
||||
|
||||
# -- 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', 'python-systemd.tex', u'python-systemd Documentation',
|
||||
None, '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', 'python-systemd', u'python-systemd Documentation',
|
||||
[], 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', 'python-systemd', u'python-systemd Documentation',
|
||||
u'David Strauss, Zbigniew Jędrzejewski-Szmek, Marti Raudsepp, Steven Hiscocks', 'python-systemd', 'One line description of project.',
|
||||
'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'
|
||||
|
||||
|
||||
# -- Options for Epub output ---------------------------------------------------
|
||||
|
||||
# Bibliographic Dublin Core info.
|
||||
epub_title = u'python-systemd'
|
||||
epub_author = u'David Strauss, Zbigniew Jędrzejewski-Szmek, Marti Raudsepp, Steven Hiscocks'
|
||||
epub_publisher = u'David Strauss, Zbigniew Jędrzejewski-Szmek, Marti Raudsepp, Steven Hiscocks'
|
||||
epub_copyright = u'2013, David Strauss, Zbigniew Jędrzejewski-Szmek, Marti Raudsepp, Steven Hiscocks'
|
||||
|
||||
# The language of the text. It defaults to the language option
|
||||
# or en if the language is not set.
|
||||
#epub_language = ''
|
||||
|
||||
# The scheme of the identifier. Typical schemes are ISBN or URL.
|
||||
#epub_scheme = ''
|
||||
|
||||
# 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 tuple containing the cover image and cover page html template filenames.
|
||||
#epub_cover = ()
|
||||
|
||||
# HTML files that should be inserted before the pages created by sphinx.
|
||||
# The format is a list of tuples containing the path and title.
|
||||
#epub_pre_files = []
|
||||
|
||||
# HTML files shat should be inserted after the pages created by sphinx.
|
||||
# The format is a list of tuples containing the path and title.
|
||||
#epub_post_files = []
|
||||
|
||||
# A list of files that should not be packed into the epub file.
|
||||
#epub_exclude_files = []
|
||||
|
||||
# The depth of the table of contents in toc.ncx.
|
||||
#epub_tocdepth = 3
|
||||
|
||||
# Allow duplicate toc entries.
|
||||
#epub_tocdup = True
|
||||
|
||||
|
||||
# Example configuration for intersphinx: refer to the Python standard library.
|
||||
intersphinx_mapping = {'http://docs.python.org/': None}
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
`systemd.id128` module
|
||||
======================
|
||||
|
||||
.. automodule:: systemd.id128
|
||||
:members:
|
||||
:undoc-members:
|
||||
:inherited-members:
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
.. python-systemd documentation master file, created by
|
||||
sphinx-quickstart on Sat Feb 9 13:49:42 2013.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to python-systemd's documentation!
|
||||
==========================================
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
journal
|
||||
id128
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
`systemd.journal` module
|
||||
========================
|
||||
|
||||
.. automodule:: systemd.journal
|
||||
:members: send, sendv, stream, stream_fd
|
||||
:undoc-members:
|
||||
|
||||
`JournalHandler` class
|
||||
----------------------
|
||||
|
||||
.. autoclass:: JournalHandler
|
||||
|
|
@ -96,19 +96,20 @@ def stream(identifier, priority=LOG_DEBUG, level_prefix=False):
|
|||
<open file '<fdopen>', mode 'w' at 0x...>
|
||||
>>> stream.write('message...\n')
|
||||
|
||||
will produce the following message in the journal:
|
||||
will produce the following message in the journal::
|
||||
|
||||
PRIORITY=7
|
||||
SYSLOG_IDENTIFIER=myapp
|
||||
MESSAGE=message...
|
||||
PRIORITY=7
|
||||
SYSLOG_IDENTIFIER=myapp
|
||||
MESSAGE=message...
|
||||
|
||||
Using the interface with print might be more convinient:
|
||||
|
||||
>>> from __future__ import print_function
|
||||
>>> print('message...', file=stream)
|
||||
|
||||
priority is the syslog priority, one of LOG_EMERG, LOG_ALERT,
|
||||
LOG_CRIT, LOG_ERR, LOG_WARNING, LOG_NOTICE, LOG_INFO, LOG_DEBUG.
|
||||
priority is the syslog priority, one of `LOG_EMERG`,
|
||||
`LOG_ALERT`, `LOG_CRIT`, `LOG_ERR`, `LOG_WARNING`,
|
||||
`LOG_NOTICE`, `LOG_INFO`, `LOG_DEBUG`.
|
||||
|
||||
level_prefix is a boolean. If true, kernel-style log priority
|
||||
level prefixes (such as '<1>') are interpreted. See
|
||||
|
|
@ -131,8 +132,8 @@ class JournalHandler(_logging.Handler):
|
|||
>>> log.addHandler(journal.JournalHandler())
|
||||
>>> log.warn("Some message: %s", detail)
|
||||
|
||||
Note that by default, message levels INFO and DEBUG are ignored
|
||||
by the logging framework. To enable those log levels:
|
||||
Note that by default, message levels `INFO` and `DEBUG` are
|
||||
ignored by the logging framework. To enable those log levels:
|
||||
|
||||
>>> log.setLevel(logging.DEBUG)
|
||||
|
||||
|
|
@ -147,16 +148,15 @@ class JournalHandler(_logging.Handler):
|
|||
|
||||
>>> logging.root.addHandler(journal.JournalHandler())
|
||||
|
||||
For more complex configurations when using dictConfig or
|
||||
fileConfig, specify 'systemd.journal.JournalHandler' as the
|
||||
For more complex configurations when using `dictConfig` or
|
||||
`fileConfig`, specify `systemd.journal.JournalHandler` as the
|
||||
handler class. Only standard handler configuration options
|
||||
are supported: level, formatter, filters.
|
||||
are supported: `level`, `formatter`, `filters`.
|
||||
|
||||
The following journal fields will be sent:
|
||||
|
||||
MESSAGE, PRIORITY, THREAD_NAME, CODE_FILE, CODE_LINE,
|
||||
CODE_FUNC, LOGGER (name as supplied to getLogger call),
|
||||
MESSAGE_ID (optional, see above).
|
||||
`MESSAGE`, `PRIORITY`, `THREAD_NAME`, `CODE_FILE`, `CODE_LINE`,
|
||||
`CODE_FUNC`, `LOGGER` (name as supplied to getLogger call),
|
||||
`MESSAGE_ID` (optional, see above).
|
||||
"""
|
||||
|
||||
def emit(self, record):
|
||||
|
|
|
|||
Loading…
Reference in New Issue