From c14fefa5b8635d030d2150a42a37894d035410bf Mon Sep 17 00:00:00 2001 From: Markus Holtermann Date: Wed, 20 Feb 2013 03:42:03 +0100 Subject: Some docstring fixes along with a docs directory --- bvggrabber/api/scheduleddeparture.py | 2 +- bvggrabber/utils/format.py | 17 ++- docs/Makefile | 153 +++++++++++++++++++++ docs/conf.py | 250 +++++++++++++++++++++++++++++++++++ docs/source/index.rst | 24 ++++ docs/source/ref/api.actual.rst | 12 ++ docs/source/ref/api.rst | 33 +++++ docs/source/ref/api.scheduled.rst | 21 +++ docs/source/ref/utils.format.rst | 24 ++++ docs/source/ref/utils.json.rst | 18 +++ docs/source/ref/utils.rst | 10 ++ 11 files changed, 556 insertions(+), 8 deletions(-) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/source/index.rst create mode 100644 docs/source/ref/api.actual.rst create mode 100644 docs/source/ref/api.rst create mode 100644 docs/source/ref/api.scheduled.rst create mode 100644 docs/source/ref/utils.format.rst create mode 100644 docs/source/ref/utils.json.rst create mode 100644 docs/source/ref/utils.rst diff --git a/bvggrabber/api/scheduleddeparture.py b/bvggrabber/api/scheduleddeparture.py index f8ed037..2e666a4 100644 --- a/bvggrabber/api/scheduleddeparture.py +++ b/bvggrabber/api/scheduleddeparture.py @@ -29,6 +29,7 @@ class Vehicle(): class ScheduledDepartureQueryApi(QueryApi): def __init__(self, station, vehicles=Vehicle._ALL, limit=5): + """:param Vehicle vehicles: a bitmask described by :class:`Vehicle`""" super(ScheduledDepartureQueryApi, self).__init__() if isinstance(station, str): self.station_enc = station.encode('iso-8859-1') @@ -41,7 +42,6 @@ class ScheduledDepartureQueryApi(QueryApi): self.limit = limit def call(self): - params = {'input': self.station_enc, 'time': timeformat(datetime.datetime.now()), 'date': dateformat(datetime.datetime.now()), diff --git a/bvggrabber/utils/format.py b/bvggrabber/utils/format.py index 5f20e42..4684fe6 100644 --- a/bvggrabber/utils/format.py +++ b/bvggrabber/utils/format.py @@ -2,9 +2,10 @@ def dateformat(dt): - """Formats a datetime object as dd.mm.yyyy + """Formats a :class:`datetime.datetime` object as dd.mm.yyyy - :param datetime dt: The datetime.datetime object to format + :param datetime.datetime dt: The :class:`datetime.datetime` object to + format :return: A formatted string :rtype: str @@ -13,9 +14,10 @@ def dateformat(dt): def fullformat(dt): - """Formats a datetime object as YYYY-MM-DD HH:MM:SS + """Formats a :class:`datetime.datetime` object as YYYY-MM-DD HH:MM:SS - :param datetime dt: The datetime.datetime object to format + :param datetime.datetime dt: The :class:`datetime.datetime` object to + format :return: A formatted string :rtype: str @@ -26,7 +28,7 @@ def fullformat(dt): def int2bin(i, length=8): """Returns the bit representation of the given integer with a minimum length of ``length``. E.g. ``int2bin(109, 7) == '1101101'`` and - ``int2bin(109, 8) == '01101101'. + ``int2bin(109, 8) == '01101101'``. :param int i: The integer to format :param int length: The minimum length of the output string. The string is @@ -41,9 +43,10 @@ def int2bin(i, length=8): def timeformat(dt): - """Formats a datetime object as HH:MM + """Formats a :class:`datetime.datetime` object as HH:MM - :param datetime dt: The datetime.datetime object to format + :param datetime.datetime dt: The :class:`datetime.datetime` object to + format :return: A formatted string :rtype: str diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..fa7a704 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,153 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = -c . +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) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +.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 ' where 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/BVG-Grabber.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/BVG-Grabber.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/BVG-Grabber" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/BVG-Grabber" + @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 --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..8de1faf --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,250 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# BVG-Grabber documentation build configuration file, created by +# sphinx-quickstart on Wed Feb 20 01:41:10 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 os +import sys + +sys.path.insert(0, os.path.join(os.path.dirname(__file__), '..')) + +# 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.intersphinx', 'sphinx.ext.viewcode'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['source/_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 = 'BVG-Grabber' +copyright = '2013, Markus Holtermann, Christian Struck' + +# 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 = '0.0.1pre' +# The full version, including alpha/beta/rc tags. +release = '0.0.1pre' + +# 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 +# " v 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 = ['source/_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_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 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 = 'BVG-Grabberdoc' + + +# -- 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', 'BVG-Grabber.tex', 'BVG-Grabber Documentation', + 'Markus Holtermann, Christian Struck', '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', 'bvg-grabber', 'BVG-Grabber Documentation', + ['Markus Holtermann, Christian Struck'], 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', 'BVG-Grabber', 'BVG-Grabber Documentation', + 'Markus Holtermann, Christian Struck', 'BVG-Grabber', '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' + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..090a43d --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,24 @@ +.. BVG-Grabber documentation master file, created by + sphinx-quickstart on Wed Feb 20 01:41:10 2013. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to BVG-Grabber's documentation! +======================================= + +Contents: + +.. toctree:: + ref/api + ref/utils + :maxdepth: 2 + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/docs/source/ref/api.actual.rst b/docs/source/ref/api.actual.rst new file mode 100644 index 0000000..324a171 --- /dev/null +++ b/docs/source/ref/api.actual.rst @@ -0,0 +1,12 @@ +==================== +Actual Departure API +==================== + +.. automodule:: bvggrabber.api.actualdeparture + + + .. autodata:: ACTUAL_API_ENDPOINT + + + .. autoclass:: ActualDepartureQueryApi + :members: __init__, call diff --git a/docs/source/ref/api.rst b/docs/source/ref/api.rst new file mode 100644 index 0000000..06c9c9e --- /dev/null +++ b/docs/source/ref/api.rst @@ -0,0 +1,33 @@ +=== +API +=== + +.. automodule:: bvggrabber.api + + +General Functions +================= + + .. autofunction:: compute_remaining + + +Base and Main Classes +===================== + + .. autoclass:: Departure + :members: __init__, remaining, __eq__, __lt__, __str__ + + .. autoclass:: QueryApi + :members: call + + .. autoclass:: Response + :members: merge, to_json, departures, error, json, state + + +Concrete Implementations +======================== + + .. toctree:: + api.actual + api.scheduled + :maxdepth: 1 diff --git a/docs/source/ref/api.scheduled.rst b/docs/source/ref/api.scheduled.rst new file mode 100644 index 0000000..d167fb8 --- /dev/null +++ b/docs/source/ref/api.scheduled.rst @@ -0,0 +1,21 @@ +======================= +Scheduled Departure API +======================= + +.. automodule:: bvggrabber.api.scheduleddeparture + + + .. autodata:: SCHEDULED_API_ENDPOINT + + + .. autoclass:: ScheduledDepartureQueryApi + :members: __init__, call + + +Helper Classes +============== + + .. autoclass:: Vehicle + :members: + :undoc-members: + :private-members: \ No newline at end of file diff --git a/docs/source/ref/utils.format.rst b/docs/source/ref/utils.format.rst new file mode 100644 index 0000000..b4b588b --- /dev/null +++ b/docs/source/ref/utils.format.rst @@ -0,0 +1,24 @@ +==================== +Formatting Utilities +==================== + +.. automodule:: bvggrabber.utils.format + + +Functions +========= + +Time and Date related +--------------------- + + .. autofunction:: dateformat + + .. autofunction:: fullformat + + .. autofunction:: timeformat + + +Others +------ + + .. autofunction:: int2bin diff --git a/docs/source/ref/utils.json.rst b/docs/source/ref/utils.json.rst new file mode 100644 index 0000000..92bd70c --- /dev/null +++ b/docs/source/ref/utils.json.rst @@ -0,0 +1,18 @@ +=== +API +=== + +.. automodule:: bvggrabber.utils.json + + +General Functions +================= + + .. autofunction:: is_not_method + + +Classes +======= + + .. autoclass:: ObjectJSONEncoder + :members: default diff --git a/docs/source/ref/utils.rst b/docs/source/ref/utils.rst new file mode 100644 index 0000000..7fca500 --- /dev/null +++ b/docs/source/ref/utils.rst @@ -0,0 +1,10 @@ +===== +Utils +===== + +.. automodule:: bvggrabber.utils + + .. toctree:: + utils.format + utils.json + :maxdepth: 1 -- cgit v1.2.3