[SQL-CVS] SQLObject development repository branch sphinx-docs created. 3.0.0a1-23-ga4bff12
SQLObject is a Python ORM.
Brought to you by:
ianbicking,
phd
From: Oleg B. <no...@so...> - 2015-07-23 01:11:42
|
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 created at a4bff128db859869c77ca50789cb9c9bfe5dc76f (commit) - Log ----------------------------------------------------------------- http://sourceforge.net/p/sqlobject/sqlobject/ci/a4bff128db859869c77ca50789cb9c9bfe5dc76f commit a4bff128db859869c77ca50789cb9c9bfe5dc76f 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.txt b/docs/api/modules.txt new file mode 100644 index 0000000..656ed22 --- /dev/null +++ b/docs/api/modules.txt @@ -0,0 +1,7 @@ +sqlobject +========= + +.. toctree:: + :maxdepth: 4 + + sqlobject diff --git a/docs/api/sqlobject.boundattributes.txt b/docs/api/sqlobject.boundattributes.txt new file mode 100644 index 0000000..1518f8d --- /dev/null +++ b/docs/api/sqlobject.boundattributes.txt @@ -0,0 +1,7 @@ +sqlobject.boundattributes module +================================ + +.. automodule:: sqlobject.boundattributes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.cache.txt b/docs/api/sqlobject.cache.txt new file mode 100644 index 0000000..6c74d5b --- /dev/null +++ b/docs/api/sqlobject.cache.txt @@ -0,0 +1,7 @@ +sqlobject.cache module +====================== + +.. automodule:: sqlobject.cache + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.classregistry.txt b/docs/api/sqlobject.classregistry.txt new file mode 100644 index 0000000..0882491 --- /dev/null +++ b/docs/api/sqlobject.classregistry.txt @@ -0,0 +1,7 @@ +sqlobject.classregistry module +============================== + +.. automodule:: sqlobject.classregistry + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.col.txt b/docs/api/sqlobject.col.txt new file mode 100644 index 0000000..5282fc2 --- /dev/null +++ b/docs/api/sqlobject.col.txt @@ -0,0 +1,7 @@ +sqlobject.col module +==================== + +.. automodule:: sqlobject.col + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.conftest.txt b/docs/api/sqlobject.conftest.txt new file mode 100644 index 0000000..8e56428 --- /dev/null +++ b/docs/api/sqlobject.conftest.txt @@ -0,0 +1,7 @@ +sqlobject.conftest module +========================= + +.. automodule:: sqlobject.conftest + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.constraints.txt b/docs/api/sqlobject.constraints.txt new file mode 100644 index 0000000..ad39272 --- /dev/null +++ b/docs/api/sqlobject.constraints.txt @@ -0,0 +1,7 @@ +sqlobject.constraints module +============================ + +.. automodule:: sqlobject.constraints + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.converters.txt b/docs/api/sqlobject.converters.txt new file mode 100644 index 0000000..82b5cff --- /dev/null +++ b/docs/api/sqlobject.converters.txt @@ -0,0 +1,7 @@ +sqlobject.converters module +=========================== + +.. automodule:: sqlobject.converters + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.dbconnection.txt b/docs/api/sqlobject.dbconnection.txt new file mode 100644 index 0000000..6a6adc3 --- /dev/null +++ b/docs/api/sqlobject.dbconnection.txt @@ -0,0 +1,7 @@ +sqlobject.dbconnection module +============================= + +.. automodule:: sqlobject.dbconnection + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.dberrors.txt b/docs/api/sqlobject.dberrors.txt new file mode 100644 index 0000000..3035746 --- /dev/null +++ b/docs/api/sqlobject.dberrors.txt @@ -0,0 +1,7 @@ +sqlobject.dberrors module +========================= + +.. automodule:: sqlobject.dberrors + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.declarative.txt b/docs/api/sqlobject.declarative.txt new file mode 100644 index 0000000..9cc7e9b --- /dev/null +++ b/docs/api/sqlobject.declarative.txt @@ -0,0 +1,7 @@ +sqlobject.declarative module +============================ + +.. automodule:: sqlobject.declarative + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.events.txt b/docs/api/sqlobject.events.txt new file mode 100644 index 0000000..8c33239 --- /dev/null +++ b/docs/api/sqlobject.events.txt @@ -0,0 +1,7 @@ +sqlobject.events module +======================= + +.. automodule:: sqlobject.events + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.firebird.firebirdconnection.txt b/docs/api/sqlobject.firebird.firebirdconnection.txt new file mode 100644 index 0000000..6fdf26e --- /dev/null +++ b/docs/api/sqlobject.firebird.firebirdconnection.txt @@ -0,0 +1,7 @@ +sqlobject.firebird.firebirdconnection module +============================================ + +.. automodule:: sqlobject.firebird.firebirdconnection + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.firebird.txt b/docs/api/sqlobject.firebird.txt new file mode 100644 index 0000000..78cec9a --- /dev/null +++ b/docs/api/sqlobject.firebird.txt @@ -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.txt b/docs/api/sqlobject.include.hashcol.txt new file mode 100644 index 0000000..76396aa --- /dev/null +++ b/docs/api/sqlobject.include.hashcol.txt @@ -0,0 +1,7 @@ +sqlobject.include.hashcol module +================================ + +.. automodule:: sqlobject.include.hashcol + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.include.txt b/docs/api/sqlobject.include.txt new file mode 100644 index 0000000..b438105 --- /dev/null +++ b/docs/api/sqlobject.include.txt @@ -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.index.txt b/docs/api/sqlobject.index.txt new file mode 100644 index 0000000..bc96433 --- /dev/null +++ b/docs/api/sqlobject.index.txt @@ -0,0 +1,7 @@ +sqlobject.index module +====================== + +.. automodule:: sqlobject.index + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.inheritance.iteration.txt b/docs/api/sqlobject.inheritance.iteration.txt new file mode 100644 index 0000000..0e9538f --- /dev/null +++ b/docs/api/sqlobject.inheritance.iteration.txt @@ -0,0 +1,7 @@ +sqlobject.inheritance.iteration module +====================================== + +.. automodule:: sqlobject.inheritance.iteration + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.inheritance.tests.testDestroyCascade.txt b/docs/api/sqlobject.inheritance.tests.testDestroyCascade.txt new file mode 100644 index 0000000..7dc60f6 --- /dev/null +++ b/docs/api/sqlobject.inheritance.tests.testDestroyCascade.txt @@ -0,0 +1,7 @@ +sqlobject.inheritance.tests.testDestroyCascade module +===================================================== + +.. automodule:: sqlobject.inheritance.tests.testDestroyCascade + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.inheritance.tests.test_aggregates.txt b/docs/api/sqlobject.inheritance.tests.test_aggregates.txt new file mode 100644 index 0000000..ee01f6b --- /dev/null +++ b/docs/api/sqlobject.inheritance.tests.test_aggregates.txt @@ -0,0 +1,7 @@ +sqlobject.inheritance.tests.test_aggregates module +================================================== + +.. automodule:: sqlobject.inheritance.tests.test_aggregates + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.inheritance.tests.test_asdict.txt b/docs/api/sqlobject.inheritance.tests.test_asdict.txt new file mode 100644 index 0000000..ff95591 --- /dev/null +++ b/docs/api/sqlobject.inheritance.tests.test_asdict.txt @@ -0,0 +1,7 @@ +sqlobject.inheritance.tests.test_asdict module +============================================== + +.. automodule:: sqlobject.inheritance.tests.test_asdict + :members: + :undoc-members: + :show-inheritance: ... 2067 lines suppressed ... hooks/post-receive -- SQLObject development repository |