Regenerated Sphinx docs

docs/Makefile

@@ -1,89 +1,19 @@
-# Makefile for Sphinx documentation
+# Minimal 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) source
-
-.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+SOURCEDIR     = .
+BUILDDIR      = _build
 
+# Put it first so that "make" without argument is like "make help".
 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/PyTrie.qhcp"
-	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PyTrie.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."
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-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."
+.PHONY: help Makefile
 
-doctest:
-	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
-	@echo "Testing of doctests in the sources finished, look at the " \
-	      "results in $(BUILDDIR)/doctest/output.txt."
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/build/html/.buildinfo → docs/_build/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 49eb2102ba31b226284e9e3ab1d89fe3
+config: c836f18e6a7021619792fe2482a16499
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_sources/index.txt → docs/_build/html/_sources/docs/index.rst.txt

@@ -1,8 +1,15 @@
-.. PyTrie documentation master file, created by sphinx-quickstart on Sun Dec 20 20:05:26 2009.
+.. PyTrie documentation master file, created by
+   sphinx-quickstart on Sat Dec 26 19:56:21 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
 
 Welcome to PyTrie's documentation!
 ==================================
 
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
 .. automodule:: pytrie
 
 Reference documentation
@@ -49,6 +56,7 @@ Original mapping API methods
 The following methods have the standard mapping signature and semantics.
 
 .. automethod:: Trie.__len__
+.. automethod:: Trie.__bool__
 .. automethod:: Trie.__iter__
 .. automethod:: Trie.__contains__
 .. automethod:: Trie.__getitem__
@@ -57,15 +65,20 @@ The following methods have the standard mapping signature and semantics.
 .. automethod:: Trie.__repr__
 .. automethod:: Trie.clear
 .. automethod:: Trie.copy
-.. automethod:: Trie.has_key
 
 Internals
 ~~~~~~~~~
 Tries are implemented as trees of :class:`Node` instances. You don't need to
 worry about them unless unless you want to extend or replace :class:`Node` with
 a new node factory and bind it to :attr:`Trie.NodeFactory`.
 
-.. autoclass:: Node()
+.. autoclass:: Node
     :show-inheritance:
     :members:
-
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/_build/html/_sources/index.rst.txt

@@ -0,0 +1,84 @@
+.. PyTrie documentation master file, created by
+   sphinx-quickstart on Sat Dec 26 19:56:21 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to PyTrie's documentation!
+==================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+.. automodule:: pytrie
+
+Reference documentation
+-----------------------
+
+Classes
+~~~~~~~
+.. autoclass:: Trie
+    :show-inheritance:
+    :members: __init__, fromkeys, KeyFactory, NodeFactory
+.. autoclass:: StringTrie
+    :show-inheritance:
+.. autoclass:: SortedTrie
+    :show-inheritance:
+.. autoclass:: SortedStringTrie
+    :show-inheritance:
+
+Trie methods
+~~~~~~~~~~~~
+The following methods are specific to tries; they are not part of the mapping API.
+
+.. automethod:: Trie.longest_prefix(key[, default])
+.. automethod:: Trie.longest_prefix_value(key[, default])
+.. automethod:: Trie.longest_prefix_item(key[, default])
+.. automethod:: Trie.iter_prefixes
+.. automethod:: Trie.iter_prefix_values
+.. automethod:: Trie.iter_prefix_items
+
+Extended mapping API methods
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The following methods extend the respective mapping API methods with an optional
+``prefix`` parameter. If not ``None``, only keys (or associated values/items)
+that start with ``prefix`` are returned.
+
+.. automethod:: Trie.keys
+.. automethod:: Trie.values
+.. automethod:: Trie.items
+.. automethod:: Trie.iterkeys
+.. automethod:: Trie.itervalues
+.. automethod:: Trie.iteritems
+
+Original mapping API methods
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The following methods have the standard mapping signature and semantics.
+
+.. automethod:: Trie.__len__
+.. automethod:: Trie.__bool__
+.. automethod:: Trie.__iter__
+.. automethod:: Trie.__contains__
+.. automethod:: Trie.__getitem__
+.. automethod:: Trie.__setitem__
+.. automethod:: Trie.__delitem__
+.. automethod:: Trie.__repr__
+.. automethod:: Trie.clear
+.. automethod:: Trie.copy
+
+Internals
+~~~~~~~~~
+Tries are implemented as trees of :class:`Node` instances. You don't need to
+worry about them unless unless you want to extend or replace :class:`Node` with
+a new node factory and bind it to :attr:`Trie.NodeFactory`.
+
+.. autoclass:: Node
+    :show-inheritance:
+    :members:
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`