From 370a4b624987d556d065a8fef23b7823aa5b47fe Mon Sep 17 00:00:00 2001 From: Lars Immisch Date: Fri, 31 Mar 2017 00:25:00 +0200 Subject: [PATCH] Regenerated doc. --- doc/conf.py | 228 +++++++++++++++++++++++--------------------------- doc/index.rst | 24 ++++-- 2 files changed, 121 insertions(+), 131 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index e3806f5..f1fb549 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,182 +1,160 @@ # -*- coding: utf-8 -*- # -# alsaaudio documentation build configuration file, created by -# sphinx-quickstart on Sat Nov 22 00:17:09 2008. +# alsaaudio documentation documentation build configuration file, created by +# sphinx-quickstart on Thu Mar 30 23:52:21 2017. # -# This file is execfile()d with the current directory set to its containing dir. +# This file is execfile()d with the current directory set to its +# containing dir. # -# The contents of this file are pickled, so don't put values in the namespace -# that aren't pickleable (module imports are okay, they're removed automatically). +# Note that not all possible configuration values are present in this +# autogenerated file. # -# All configuration values have a default value; values that are commented out -# serve to show the default value. +# 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. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) +import sys sys.path.insert(0, '..') from setup import pyalsa_version -# If your extensions are in another directory, add it here. If the directory -# is relative to the documentation root, use os.path.abspath to make it -# absolute, like shown here. -#sys.path.append(os.path.abspath('some/directory')) -# General configuration -# --------------------- +# -- General configuration ------------------------------------------------ -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +# 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'] +templates_path = ['_templates'] -# The suffix of source filenames. +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] source_suffix = '.rst' # The master toctree document. master_doc = 'index' -# General substitutions. -project = u'alsaaudio' -copyright = u'2008-20017, Casper Wilstrup, Lars Immisch' +# General information about the project. +project = u'alsaaudio documentation' +copyright = u'2017, Lars Immisch & Casper Wilstrup' +author = u'Lars Immisch & Casper Wilstrup' -# The default replacements for |version| and |release|, also used in various -# other places throughout the built documents. +# 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 = pyalsa_version # The full version, including alpha/beta/rc tags. -release = pyalsa_version +release = version -# 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' +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None -# List of documents that shouldn't be included in the build. -#unused_docs = [] - -# List of directories, relative to source directories, that shouldn't be searched -# for source files. -exclude_trees = ['.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 +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False -# Options for HTML output -# ----------------------- -# The style sheet to use for HTML and HTML Help pages. A file of that name -# must exist either in Sphinx' static/ path, or in one of the custom paths -# given in html_static_path. -html_style = 'default.css' +# -- Options for HTML output ---------------------------------------------- -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' -# 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 +# 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 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'] +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 = {} - -# 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_use_modindex = 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, the reST sources are included in the HTML build as _sources/. -#html_copy_source = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = '' +# -- Options for HTMLHelp output ------------------------------------------ # Output file base name for HTML help builder. -htmlhelp_basename = 'alsaaudiodoc' +htmlhelp_basename = 'alsaaudiodocumentationdoc' -# Options for LaTeX output -# ------------------------ +# -- Options for LaTeX output --------------------------------------------- -# The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', -# The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} # Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, document class [howto/manual]). +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). latex_documents = [ - ('index', 'alsaaudio.tex', u'alsaaudio Documentation', - u'Casper Wilstrup, Lars Immisch', 'manual'), + (master_doc, 'alsaaudiodocumentation.tex', u'alsaaudio documentation Documentation', + u'Lars Immisch', '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 +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'alsaaudiodocumentation', u'alsaaudio documentation Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'alsaaudiodocumentation', u'alsaaudio documentation Documentation', + author, 'alsaaudiodocumentation', 'One line description of project.', + 'Miscellaneous'), +] -# Additional stuff for the LaTeX preamble. -#latex_preamble = '' -# Documents to append as an appendix to all manuals. -#latex_appendices = [] -# If false, no module index is generated. -#latex_use_modindex = True diff --git a/doc/index.rst b/doc/index.rst index 658d656..d0b73d6 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,22 +1,32 @@ +.. alsaaudio documentation documentation master file, created by + sphinx-quickstart on Thu Mar 30 23:52:21 2017. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + alsaaudio documentation -======================= +=================================================== .. toctree:: :maxdepth: 2 + :caption: Contents: pyalsaaudio terminology libalsaaudio +Download +======== -Github pages -================= - -* `Project page `_ * `Download from pypi `_ -* `Bug tracker `_ + + +Github +====== +* `Github repository `_ +* `Github Bug tracker `_ + Indices and tables ================== @@ -24,3 +34,5 @@ Indices and tables * :ref:`modindex` * :ref:`search` + +