|
From: Oleg B. <no...@so...> - 2016-08-12 04:44:11
|
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 407f6b93b1fd90d570aa7e6cbb49af291b368da3 (commit)
via 87d7a5ce84f0beb6e2c12ee0bf1a935f9dd8dc19 (commit)
via b41ecb020ec3877c452994ecf770550128253aa7 (commit)
via 6cb059288bcbfcf64d11eda5379b1e210e47f150 (commit)
via f641a45c7eca7644730f15336c76cd950fb874af (commit)
via bbf0c5a08c648cf05c0c4fbe1fdb664760226ba3 (commit)
via a65f48fcb30a51238949970e339e6d4965d53627 (commit)
via de699fdcacdc23975b6adba4bc21e9cf7e9fbece (commit)
via ab712792175ee8d7d73ba4dad815da7c469856f0 (commit)
via de6860839138cf4a073b1f55568fb3a5e6902e29 (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 (407f6b93b1fd90d570aa7e6cbb49af291b368da3)
\
N -- N -- N (87d7a5ce84f0beb6e2c12ee0bf1a935f9dd8dc19)
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/87d7a5ce84f0beb6e2c12ee0bf1a935f9dd8dc19
commit 87d7a5ce84f0beb6e2c12ee0bf1a935f9dd8dc19
Author: Oleg Broytman <ph...@ph...>
Date: Fri Aug 12 06:39:57 2016 +0300
Add docs toctree and links to autogenerated indices and search
[skip ci]
diff --git a/docs/index.rst b/docs/index.rst
index ff0f463..25c07dd 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -13,23 +13,26 @@ applications.
Documentation
=============
-* `Download <download.html>`_
-* `Mailing list, bugs, etc. <community.html>`_
-* `Related projects and articles <links.html>`_
-
-* `News and updates <News.html>`_
-* `SQLObject and Python 3 <Python3.html>`_
-* `Main SQLObject documentation <SQLObject.html>`_
-* `Frequently Asked Questions <FAQ.html>`_
-* `sqlbuilder documentation <SQLBuilder.html>`_
-* `select() and SelectResults <SelectResults.html>`_
-* `sqlobject-admin documentation <sqlobject-admin.html>`_
-* `Inheritance <Inheritance.html>`_
-* `Versioning <Versioning.html>`_
-* `Views <Views.html>`_
-* `Developer Guide <DeveloperGuide.html>`_
-* `Contributors <Authors.html>`_
-* `TODO <TODO.html>`_
+.. toctree::
+ :maxdepth: 1
+
+ download
+ community
+ links
+
+ News
+ Python3
+ SQLObject
+ FAQ
+ SQLBuilder
+ SelectResults
+ sqlobject-admin
+ Inheritance
+ Versioning
+ Views
+ DeveloperGuide
+ Authors
+ TODO
Example
=======
@@ -65,6 +68,15 @@ Here's how you'd use the object::
>>> p is p2
True
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+
.. image:: https://sourceforge.net/sflogo.php?group_id=74338&type=10
:target: https://sourceforge.net/projects/sqlobject
:class: noborder
http://sourceforge.net/p/sqlobject/sqlobject/ci/b41ecb020ec3877c452994ecf770550128253aa7
commit b41ecb020ec3877c452994ecf770550128253aa7
Author: Oleg Broytman <ph...@ph...>
Date: Mon Feb 16 21:56:33 2015 +0300
Generate docs using sphinx
Use sphinx-apidoc to generate split API docs.
diff --git a/docs/.gitignore b/docs/.gitignore
index cf1f956..bbbd193 100644
--- a/docs/.gitignore
+++ b/docs/.gitignore
@@ -1,4 +1,2 @@
-/*.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 @@
... 2313 lines suppressed ...
hooks/post-receive
--
SQLObject development repository
|
