Use Sphinx to generate API documentation.

README.md → README.rst

@@ -1,11 +1,14 @@
-# Introduction
+Introduction
+------------
 
-This script supports shelving changes for Mercurial repositories similar to `git stash`. One major difference with `git
-stash` is that changes are not stored in a stack, but rather as a named patch in a predefined location (`~/.shelf`).
+This script supports shelving changes for Mercurial repositories similar to `git
+stash`. One major difference with `git stash` is that changes are not stored in
+a stack, but rather as a named patch in a predefined location (`~/.shelf`).
 
-# Usage
+Usage
+-----
 
-The following is a listing of the help instructions from `shelve`:
+The following is a listing of the help instructions from `shelve`::
 
     usage: shelve.py [-h] [-l] [-r] [-s] [-a] [<patch name>]
 
@@ -22,11 +25,15 @@ The following is a listing of the help instructions from `shelve`:
     -a, --apply   apply the specified patch in the shelf, and remove it in case
                   it applied successfully
 
-Note that in case applying a patch causes a conflict, the patch will be merged into the original conflicting file
-similar to `merge`. For more information, see the man page of `patch`, specifically the description of the `--merge`
-command line option.
+Note that in case applying a patch causes a conflict, the patch will be merged
+into the original conflicting file similar to `merge`. For more information, see
+the man page of `patch`, specifically the description of the `--merge` command
+line option.
 
-# Bash completion support
+Bash completion support
+-----------------------
 
-To get support for auto completing patch names in BASH, make sure that the `shelve-completion.bash` script is sourced in
-your `.bashrc` or something similar, and that you execute the shelve script by directly executing `shelve.py`.
+To get support for auto completing patch names in BASH, make sure that the
+`shelve-completion.bash` script is sourced in your `.bashrc` or something
+similar, and that you execute the shelve script by directly executing
+`shelve.py`.

doc/API.rst

@@ -0,0 +1,17 @@
+API
+===
+
+The shelve API exposes the functionality that is used by the shelve command-line
+tool to interact with the shelf.
+
+:py:class:`~shelf.shelf.Shelf` -- Class providing all operations on the shelf
+-----------------------------------------------------------------------------
+
+.. autoclass:: shelf.shelf.Shelf
+    :members:
+
+:py:class:`~shelf.shelf.ShelfException` -- Base exception class for shelf exceptions
+------------------------------------------------------------------------------------
+
+.. autoclass:: shelf.shelf.ShelfException
+    :members:

doc/Makefile

@@ -0,0 +1,153 @@
+# 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) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.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 <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 "  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/shelve.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/shelve.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/shelve"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/shelve"
+	@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."

doc/command-line.rst

@@ -0,0 +1,58 @@
+Shelve command-line tool
+------------------------
+
+This shelve command-line tool ``shelve.py`` supports shelving changes for
+Mercurial and Subversion repositories similar to ``git stash``.  One major
+difference with ``git stash`` is that changes are not stored in a stack, but
+rather as a named patch in a predefined location (``~/.shelf``).
+
+Shelve allows to user to temporarily shelve all changes in a dirty working
+directory away to the shelf. All changes in the repository are reverted, and the
+repository is back in a clean state.
+
+Usage
+=====
+
+To temporarily shelve all changes including all added and removed files in a
+repository issue:
+
+.. code-block:: none
+
+    $ shelve.py <patch name>
+
+``<patch name>`` is a user-defined name that describes the contents of the
+patch. In case a patch with the given name already exists, shelve will ask to
+user to either overwrite the existing patch, or specify an alternative name for
+the patch. The shelve command can be issued from any path within a repository,
+provided it is either a Mercurial or Subversion respository.
+
+All changes that are shelved in this way can be inspected using ``shelve.py
+-l``, and shown using ``shelve.py -s <patch name>``.
+
+Changes that were previously saved can be restored again using ``shelve.py -a
+<patch name>``,  potentially on top of a different commit. In case the changes
+applied cleanly to the current repository, the entry for the patch is
+automatically removed from the shelf.  Otherwise, the files will be merged in
+place (similar to ``merge``), and the patch will remain in the shelf.
+
+For more information on the usage of shelve:
+
+.. code-block:: none
+
+    $ shelve.py -h
+
+Bash completion support
+=======================
+
+When installing shelve, a command-line completion script is automatically
+installed to ``/etc/bash_completion.d``. This provides support for auto
+completing patch names in Bash.
+
+Installation
+============
+
+To install shelve:
+
+.. code-block:: none
+
+    # easy_install -U shelve