|
From: Oleg B. <no...@so...> - 2016-08-10 15:15:57
|
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "SQLObject development repository".
The branch, sphinx-docs has been updated
discards 70115a80aa04cca16ea0d0e2283276a0cd2cc53b (commit)
via 86ffdb3b4feaa2340815addc75ec846b1cc423f4 (commit)
via 0301abee2c622b0718d2181361bc9719d557af6c (commit)
via 539d6d0cca09c7d26eef7e3c20a88ea76b8570aa (commit)
via 58b9fe8faf5cb78225a982b71a5775c217d1f2b0 (commit)
via 5e83f5b9c9ff92c1b188a904edfcb5a10c8aac3c (commit)
via e17be44c57a217fb2d1c0741aa5ab14afad631c3 (commit)
via 3d53e359aabaa0ca86cb7c319b2019dd269174d9 (commit)
via c05c32dc337b6c2a9c9750509d53641b0a8e865b (commit)
via 12790bba0f012954f3811d54a5aeb546e629c7ff (commit)
via 372fa6303abde2fa1afa32b44b3692614fc72c23 (commit)
via 84097cfaf0a72e2a2390f4990168c319c6d619bc (commit)
via 10059c1eff5e0031d188042bfecf92a1881a34e2 (commit)
via 48e06c2db7d67b06a84015c19a9c909629568d69 (commit)
via e37b03a019184e9258e67da1716c4898c9d2b429 (commit)
via 4ea1194ce9277b237e5ef65b65cb8d8b6718a9fc (commit)
via 936732a0e84496343e2d357706e25b112c3221a3 (commit)
via d0f2abc7ce2011f2943f11a40ec7f71a72a2473f (commit)
via 53bc9174aa2d6e72d8a5d3facdbc9f450fec4bc3 (commit)
via 2476dfb15cf3f6c62f4c0c2c25ad59847687d496 (commit)
via dbfad29c3ab865a69d4661e3b2be96f3255e82db (commit)
via c5b45491c256f3d1bdbfce9775472c59faf8dde2 (commit)
via 9785f246ee72d20f77fd5e9290bb59f587a49287 (commit)
via 6ec83457d064928b2ecb1edca36b6824d029e9ab (commit)
via 76b057eba4844088e72e319c18bffb94ee87b6a1 (commit)
via 56bcb03d7c0b8b8c5e1d010913cf24d8d4aa153b (commit)
via 0fbf8949b3a56e87582d7f08f592809d6fdba62b (commit)
via b4c5f02b368d8a3a570f2edf6150d0da4c7e503b (commit)
via 4f62b3980d04c08ce4c9f058b1a89d44f2c85442 (commit)
via c442ad93897d7515b5d40b77af22212248b7e1c9 (commit)
This update added new revisions after undoing existing revisions. That is
to say, the old revision is not a strict subset of the new revision. This
situation occurs when you --force push a change and generate a repository
containing something like this:
* -- * -- B -- O -- O -- O (70115a80aa04cca16ea0d0e2283276a0cd2cc53b)
\
N -- N -- N (86ffdb3b4feaa2340815addc75ec846b1cc423f4)
When this happens we assume that you've already had alert emails for all
of the O revisions, and so we here report only the revisions in the N
branch from the common base, B.
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
http://sourceforge.net/p/sqlobject/sqlobject/ci/86ffdb3b4feaa2340815addc75ec846b1cc423f4
commit 86ffdb3b4feaa2340815addc75ec846b1cc423f4
Author: Oleg Broytman <ph...@ph...>
Date: Mon Feb 16 21:56:33 2015 +0300
Generate docs using sphinx
Used sphinx-apidoc to generate split API docs.
diff --git a/docs/.gitignore b/docs/.gitignore
index 5937020..cf1f956 100644
--- a/docs/.gitignore
+++ b/docs/.gitignore
@@ -1,3 +1,4 @@
/*.html
+/_build/
/data.db
/html
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..5188142
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,183 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# 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 coverage 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 " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+ @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 " xml to make Docutils-native XML files"
+ @echo " pseudoxml to make pseudoxml-XML files for display purposes"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+ @echo " coverage to run coverage check of 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/SQLObject.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SQLObject.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/SQLObject"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SQLObject"
+ @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."
+
+latexpdfja:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through platex and dvipdfmx..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+ @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."
+
+coverage:
+ $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+ @echo "Testing of coverage in the sources finished, look at the " \
+ "results in $(BUILDDIR)/coverage/python.txt."
+
+xml:
+ $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+ @echo
+ @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+ $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+ @echo
+ @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
diff --git a/docs/api/modules.rst b/docs/api/modules.rst
new file mode 100644
index 0000000..656ed22
--- /dev/null
+++ b/docs/api/modules.rst
@@ -0,0 +1,7 @@
+sqlobject
+=========
+
+.. toctree::
+ :maxdepth: 4
+
+ sqlobject
diff --git a/docs/api/sqlobject.boundattributes.rst b/docs/api/sqlobject.boundattributes.rst
new file mode 100644
index 0000000..1518f8d
--- /dev/null
+++ b/docs/api/sqlobject.boundattributes.rst
@@ -0,0 +1,7 @@
+sqlobject.boundattributes module
+================================
+
+.. automodule:: sqlobject.boundattributes
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/api/sqlobject.cache.rst b/docs/api/sqlobject.cache.rst
new file mode 100644
index 0000000..6c74d5b
--- /dev/null
+++ b/docs/api/sqlobject.cache.rst
@@ -0,0 +1,7 @@
+sqlobject.cache module
+======================
+
+.. automodule:: sqlobject.cache
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/api/sqlobject.classregistry.rst b/docs/api/sqlobject.classregistry.rst
new file mode 100644
index 0000000..0882491
--- /dev/null
+++ b/docs/api/sqlobject.classregistry.rst
@@ -0,0 +1,7 @@
+sqlobject.classregistry module
+==============================
+
+.. automodule:: sqlobject.classregistry
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/api/sqlobject.col.rst b/docs/api/sqlobject.col.rst
new file mode 100644
index 0000000..5282fc2
--- /dev/null
+++ b/docs/api/sqlobject.col.rst
@@ -0,0 +1,7 @@
+sqlobject.col module
+====================
+
+.. automodule:: sqlobject.col
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/api/sqlobject.compat.rst b/docs/api/sqlobject.compat.rst
new file mode 100644
index 0000000..cdb4f6d
--- /dev/null
+++ b/docs/api/sqlobject.compat.rst
@@ -0,0 +1,7 @@
+sqlobject.compat module
+=======================
+
+.. automodule:: sqlobject.compat
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/api/sqlobject.conftest.rst b/docs/api/sqlobject.conftest.rst
new file mode 100644
index 0000000..8e56428
--- /dev/null
+++ b/docs/api/sqlobject.conftest.rst
@@ -0,0 +1,7 @@
+sqlobject.conftest module
+=========================
+
+.. automodule:: sqlobject.conftest
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/api/sqlobject.constraints.rst b/docs/api/sqlobject.constraints.rst
new file mode 100644
index 0000000..ad39272
--- /dev/null
+++ b/docs/api/sqlobject.constraints.rst
@@ -0,0 +1,7 @@
+sqlobject.constraints module
+============================
+
+.. automodule:: sqlobject.constraints
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/api/sqlobject.converters.rst b/docs/api/sqlobject.converters.rst
new file mode 100644
index 0000000..82b5cff
--- /dev/null
+++ b/docs/api/sqlobject.converters.rst
@@ -0,0 +1,7 @@
+sqlobject.converters module
+===========================
+
+.. automodule:: sqlobject.converters
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/api/sqlobject.dbconnection.rst b/docs/api/sqlobject.dbconnection.rst
new file mode 100644
index 0000000..6a6adc3
--- /dev/null
+++ b/docs/api/sqlobject.dbconnection.rst
@@ -0,0 +1,7 @@
+sqlobject.dbconnection module
+=============================
+
+.. automodule:: sqlobject.dbconnection
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/api/sqlobject.dberrors.rst b/docs/api/sqlobject.dberrors.rst
new file mode 100644
index 0000000..3035746
--- /dev/null
+++ b/docs/api/sqlobject.dberrors.rst
@@ -0,0 +1,7 @@
+sqlobject.dberrors module
+=========================
+
+.. automodule:: sqlobject.dberrors
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/api/sqlobject.declarative.rst b/docs/api/sqlobject.declarative.rst
new file mode 100644
index 0000000..9cc7e9b
--- /dev/null
+++ b/docs/api/sqlobject.declarative.rst
@@ -0,0 +1,7 @@
+sqlobject.declarative module
+============================
+
+.. automodule:: sqlobject.declarative
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/api/sqlobject.events.rst b/docs/api/sqlobject.events.rst
new file mode 100644
index 0000000..8c33239
--- /dev/null
+++ b/docs/api/sqlobject.events.rst
@@ -0,0 +1,7 @@
+sqlobject.events module
+=======================
+
+.. automodule:: sqlobject.events
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/api/sqlobject.firebird.firebirdconnection.rst b/docs/api/sqlobject.firebird.firebirdconnection.rst
new file mode 100644
index 0000000..6fdf26e
--- /dev/null
+++ b/docs/api/sqlobject.firebird.firebirdconnection.rst
@@ -0,0 +1,7 @@
+sqlobject.firebird.firebirdconnection module
+============================================
+
+.. automodule:: sqlobject.firebird.firebirdconnection
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/api/sqlobject.firebird.rst b/docs/api/sqlobject.firebird.rst
new file mode 100644
index 0000000..78cec9a
--- /dev/null
+++ b/docs/api/sqlobject.firebird.rst
@@ -0,0 +1,15 @@
+sqlobject.firebird package
+==========================
+
+.. automodule:: sqlobject.firebird
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+ sqlobject.firebird.firebirdconnection
+
diff --git a/docs/api/sqlobject.include.hashcol.rst b/docs/api/sqlobject.include.hashcol.rst
new file mode 100644
index 0000000..76396aa
--- /dev/null
+++ b/docs/api/sqlobject.include.hashcol.rst
@@ -0,0 +1,7 @@
+sqlobject.include.hashcol module
+================================
+
+.. automodule:: sqlobject.include.hashcol
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/api/sqlobject.include.rst b/docs/api/sqlobject.include.rst
new file mode 100644
index 0000000..b438105
--- /dev/null
+++ b/docs/api/sqlobject.include.rst
@@ -0,0 +1,15 @@
+sqlobject.include package
+=========================
+
+.. automodule:: sqlobject.include
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+ sqlobject.include.hashcol
+
diff --git a/docs/api/sqlobject.include.tests.rst b/docs/api/sqlobject.include.tests.rst
new file mode 100644
index 0000000..e17b4de
--- /dev/null
+++ b/docs/api/sqlobject.include.tests.rst
@@ -0,0 +1,15 @@
... 2556 lines suppressed ...
hooks/post-receive
--
SQLObject development repository
|
