diff options
author | Lars Wirzenius <liw@liw.fi> | 2011-06-24 17:54:35 +0100 |
---|---|---|
committer | Lars Wirzenius <liw@liw.fi> | 2011-06-24 17:54:35 +0100 |
commit | 3fd242c429bbf70c8ddf52f5d1dc3f3d42b09f94 (patch) | |
tree | a48d55618e997a469213a12b303d831b81f89644 | |
parent | e71418bf904d476a3cb2784c0efebff7d6555bf6 (diff) | |
parent | 6dedc980681fad23c358576b1d442e114a961de6 (diff) | |
download | python-ttystatus-3fd242c429bbf70c8ddf52f5d1dc3f3d42b09f94.tar.gz |
Use sphinx for API docs.
-rw-r--r-- | Makefile | 2 | ||||
-rw-r--r-- | doc/Makefile | 89 | ||||
-rw-r--r-- | doc/conf.py | 196 | ||||
-rw-r--r-- | doc/index.rst | 82 | ||||
-rw-r--r-- | example.py | 2 | ||||
-rw-r--r-- | ttystatus/__init__.py | 2 |
6 files changed, 371 insertions, 2 deletions
@@ -1,4 +1,5 @@ all: + $(MAKE) -C doc html check: python -m CoverageTestRunner --ignore-missing-from=without-tests @@ -7,3 +8,4 @@ check: clean: rm -f .coverage ttystatus/*.py[co] rm -rf build + $(MAKE) -C doc clean diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..9c8bbbf --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,89 @@ +# 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) . + +.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest + +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 " 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 " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @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." + +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/ttystatus.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ttystatus.qhc" + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ + "run these through (pdf)latex." + +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 --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000..18b0e00 --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,196 @@ +# -*- coding: utf-8 -*- +# +# ttystatus documentation build configuration file, created by +# sphinx-quickstart on Fri Jun 24 17:38:08 2011. +# +# 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('.')) +sys.path.insert(0, os.path.abspath('..')) + +# -- 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. +extensions = ['sphinx.ext.autodoc'] + +# 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' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'ttystatus' +copyright = u'2011, Lars Wirzenius' + +# 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. +import ttystatus +version = ttystatus.__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 documents that shouldn't be included in the build. +#unused_docs = [] + +# List of directories, relative to source directory, 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 + +# 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. Major themes that come with +# Sphinx are currently 'default' and 'sphinxdoc'. +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 = ['_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, links to the reST sources are added to the pages. +#html_show_sourcelink = 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 = '' + +# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = '' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'ttystatusdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +# The paper size ('letter' or 'a4'). +#latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +#latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'ttystatus.tex', u'ttystatus Documentation', + u'Lars Wirzenius', '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 + +# 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 new file mode 100644 index 0000000..5f671bf --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,82 @@ +`ttystatus` -- a terminal status library +======================================== + +``ttystatus`` is a Python library for showing progress reporting and status +updates on terminals, for (Unix) command line programs. Output is +automatically adapted to the width of the terminal: truncated if it does +not fit, and re-sized if the terminal size changes. + +Output is provided via widgets. Each widgets formats some data into +a suitable form for output. It gets the data either via its initializer, +or from key/value pairs maintained by the master object. The values are +set by the user. Every time a value is updated, widgets get updated +(although the terminal is only updated every so often to give user time +to actually read the output). + + +Example +------- + +Here's an example program that searches for symlinks in a directory tree:: + + import os + import sys + + import ttystatus + + ts = ttystatus.TerminalStatus(period=0.1) + ts.add(ttystatus.ElapsedTime()) + ts.add(ttystatus.Literal(' Looking for files: ')) + ts.add(ttystatus.Counter('pathname')) + ts.add(ttystatus.Literal(' found, currently in ')) + ts.add(ttystatus.Pathname('dirname')) + + pathnames = [] + for dirname, subdirs, basenames in os.walk(sys.argv[1]): + ts['dirname'] = dirname + for basename in basenames: + pathname = os.path.join(dirname, basename) + ts['pathname'] = pathname + pathnames.append(pathname) + + ts.clear() + ts.add(ttystatus.ElapsedTime()) + ts.add(ttystatus.Literal(' Finding symlinks: ')) + ts.add(ttystatus.Counter('symlink')) + ts.add(ttystatus.Literal(' found; now at ')) + ts.add(ttystatus.Index('pathname', 'pathnames')) + ts.add(ttystatus.Literal(' (')) + ts.add(ttystatus.PercentDone('done', 'total', decimals=2)) + ts.add(ttystatus.Literal(' done) ')) + ts.add(ttystatus.RemainingTime('done', 'total')) + ts.add(ttystatus.Literal(' ')) + ts.add(ttystatus.ProgressBar('done', 'total')) + ts['pathnames'] = pathnames + ts['done'] = 0 + ts['total'] = len(pathnames) + + for pathname in pathnames: + ts['pathname'] = pathname + if os.path.islink(pathname): + ts['symlink'] = pathname + ts.notify('Symlink! %s' % pathname) + ts['done'] += 1 + + ts.finish() + +(See also the file ``example.py`` in the source distribution.) + +Reference manual +================ + +.. automodule:: ttystatus + :members: + :undoc-members: + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + @@ -59,7 +59,7 @@ def main(): ts['pathname'] = pathname if os.path.islink(pathname): ts['symlink'] = pathname -# ts.notify('Symlink! %s' % pathname) + ts.notify('Symlink! %s' % pathname) ts['done'] += 1 ts.finish() diff --git a/ttystatus/__init__.py b/ttystatus/__init__.py index 200a491..a9704e3 100644 --- a/ttystatus/__init__.py +++ b/ttystatus/__init__.py @@ -14,7 +14,7 @@ # along with this program. If not, see <http://www.gnu.org/licenses/>. -version = '0.11' +__version__ = '0.12' from messager import Messager from status import TerminalStatus |