From f4c578676fb4bab7523f2409b1deb4e4510ad773 Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Mon, 16 Feb 2015 21:56:33 +0300 Subject: [PATCH] Generate docs using sphinx Use sphinx-apidoc to generate split API docs. --- docs/.gitignore | 1 + docs/Makefile | 183 +++++++++ docs/api/modules.rst | 7 + docs/api/sqlobject.boundattributes.rst | 7 + docs/api/sqlobject.cache.rst | 7 + docs/api/sqlobject.classregistry.rst | 7 + docs/api/sqlobject.col.rst | 7 + docs/api/sqlobject.compat.rst | 7 + docs/api/sqlobject.conftest.rst | 7 + docs/api/sqlobject.constraints.rst | 7 + docs/api/sqlobject.converters.rst | 7 + docs/api/sqlobject.dbconnection.rst | 7 + docs/api/sqlobject.dberrors.rst | 7 + docs/api/sqlobject.declarative.rst | 7 + docs/api/sqlobject.events.rst | 7 + .../sqlobject.firebird.firebirdconnection.rst | 7 + docs/api/sqlobject.firebird.rst | 15 + docs/api/sqlobject.include.hashcol.rst | 7 + docs/api/sqlobject.include.rst | 22 ++ docs/api/sqlobject.include.tests.rst | 15 + .../sqlobject.include.tests.test_hashcol.rst | 7 + docs/api/sqlobject.index.rst | 7 + docs/api/sqlobject.inheritance.iteration.rst | 7 + docs/api/sqlobject.inheritance.rst | 22 ++ docs/api/sqlobject.inheritance.tests.rst | 22 ++ ...t.inheritance.tests.testDestroyCascade.rst | 7 + ...ject.inheritance.tests.test_aggregates.rst | 7 + ...qlobject.inheritance.tests.test_asdict.rst | 7 + ...nheritance.tests.test_deep_inheritance.rst | 7 + ...ject.inheritance.tests.test_foreignKey.rst | 7 + ...lobject.inheritance.tests.test_indexes.rst | 7 + ...ect.inheritance.tests.test_inheritance.rst | 7 + ...nheritance.tests.test_inheritance_tree.rst | 7 + docs/api/sqlobject.joins.rst | 7 + docs/api/sqlobject.main.rst | 7 + docs/api/sqlobject.manager.command.rst | 7 + docs/api/sqlobject.manager.rst | 15 + docs/api/sqlobject.maxdb.maxdbconnection.rst | 7 + docs/api/sqlobject.maxdb.rst | 15 + docs/api/sqlobject.mssql.mssqlconnection.rst | 7 + docs/api/sqlobject.mssql.rst | 15 + docs/api/sqlobject.mysql.mysqlconnection.rst | 7 + docs/api/sqlobject.mysql.rst | 15 + docs/api/sqlobject.postgres.pgconnection.rst | 7 + docs/api/sqlobject.postgres.rst | 15 + .../sqlobject.rdbhost.rdbhostconnection.rst | 7 + docs/api/sqlobject.rdbhost.rst | 15 + docs/api/sqlobject.rst | 54 +++ docs/api/sqlobject.sqlbuilder.rst | 7 + docs/api/sqlobject.sqlite.rst | 15 + .../api/sqlobject.sqlite.sqliteconnection.rst | 7 + docs/api/sqlobject.sresults.rst | 7 + docs/api/sqlobject.styles.rst | 7 + docs/api/sqlobject.sybase.rst | 15 + .../api/sqlobject.sybase.sybaseconnection.rst | 7 + docs/api/sqlobject.tests.dbtest.rst | 7 + docs/api/sqlobject.tests.rst | 89 +++++ docs/api/sqlobject.tests.test_ForeignKey.rst | 7 + ...object.tests.test_NoneValuedResultItem.rst | 7 + .../sqlobject.tests.test_SQLMultipleJoin.rst | 7 + .../sqlobject.tests.test_SQLRelatedJoin.rst | 7 + docs/api/sqlobject.tests.test_SingleJoin.rst | 7 + docs/api/sqlobject.tests.test_aggregates.rst | 7 + docs/api/sqlobject.tests.test_aliases.rst | 7 + docs/api/sqlobject.tests.test_asdict.rst | 7 + docs/api/sqlobject.tests.test_auto.rst | 7 + docs/api/sqlobject.tests.test_basic.rst | 7 + docs/api/sqlobject.tests.test_blob.rst | 7 + .../sqlobject.tests.test_boundattributes.rst | 7 + docs/api/sqlobject.tests.test_cache.rst | 7 + docs/api/sqlobject.tests.test_class_hash.rst | 7 + .../sqlobject.tests.test_columns_order.rst | 7 + .../sqlobject.tests.test_combining_joins.rst | 7 + docs/api/sqlobject.tests.test_comparison.rst | 7 + .../sqlobject.tests.test_complex_sorting.rst | 7 + docs/api/sqlobject.tests.test_constraints.rst | 7 + docs/api/sqlobject.tests.test_converters.rst | 7 + docs/api/sqlobject.tests.test_create_drop.rst | 7 + docs/api/sqlobject.tests.test_csvexport.rst | 7 + .../sqlobject.tests.test_cyclic_reference.rst | 7 + docs/api/sqlobject.tests.test_datetime.rst | 7 + docs/api/sqlobject.tests.test_decimal.rst | 7 + docs/api/sqlobject.tests.test_declarative.rst | 7 + .../sqlobject.tests.test_default_style.rst | 7 + docs/api/sqlobject.tests.test_delete.rst | 7 + docs/api/sqlobject.tests.test_distinct.rst | 7 + docs/api/sqlobject.tests.test_empty.rst | 7 + docs/api/sqlobject.tests.test_enum.rst | 7 + docs/api/sqlobject.tests.test_events.rst | 7 + docs/api/sqlobject.tests.test_exceptions.rst | 7 + docs/api/sqlobject.tests.test_expire.rst | 7 + docs/api/sqlobject.tests.test_groupBy.rst | 7 + docs/api/sqlobject.tests.test_identity.rst | 7 + docs/api/sqlobject.tests.test_indexes.rst | 7 + docs/api/sqlobject.tests.test_inheritance.rst | 7 + docs/api/sqlobject.tests.test_joins.rst | 7 + ...sqlobject.tests.test_joins_conditional.rst | 7 + docs/api/sqlobject.tests.test_jsonbcol.rst | 7 + docs/api/sqlobject.tests.test_jsoncol.rst | 7 + docs/api/sqlobject.tests.test_lazy.rst | 7 + docs/api/sqlobject.tests.test_md5.rst | 7 + docs/api/sqlobject.tests.test_mysql.rst | 7 + docs/api/sqlobject.tests.test_new_joins.rst | 7 + docs/api/sqlobject.tests.test_parse_uri.rst | 7 + docs/api/sqlobject.tests.test_paste.rst | 7 + .../sqlobject.tests.test_perConnection.rst | 7 + docs/api/sqlobject.tests.test_pickle.rst | 7 + docs/api/sqlobject.tests.test_picklecol.rst | 7 + docs/api/sqlobject.tests.test_postgres.rst | 7 + .../sqlobject.tests.test_reparent_sqlmeta.rst | 7 + docs/api/sqlobject.tests.test_schema.rst | 7 + docs/api/sqlobject.tests.test_select.rst | 7 + .../sqlobject.tests.test_select_through.rst | 7 + docs/api/sqlobject.tests.test_setters.rst | 7 + docs/api/sqlobject.tests.test_slice.rst | 7 + docs/api/sqlobject.tests.test_sorting.rst | 7 + docs/api/sqlobject.tests.test_sqlbuilder.rst | 7 + ...bject.tests.test_sqlbuilder_dbspecific.rst | 7 + ...ject.tests.test_sqlbuilder_importproxy.rst | 7 + ....tests.test_sqlbuilder_joins_instances.rst | 7 + docs/api/sqlobject.tests.test_sqlite.rst | 7 + .../sqlobject.tests.test_sqlmeta_idName.rst | 7 + .../sqlobject.tests.test_sqlobject_admin.rst | 7 + docs/api/sqlobject.tests.test_string_id.rst | 7 + docs/api/sqlobject.tests.test_style.rst | 7 + docs/api/sqlobject.tests.test_subqueries.rst | 7 + .../api/sqlobject.tests.test_transactions.rst | 7 + docs/api/sqlobject.tests.test_unicode.rst | 7 + docs/api/sqlobject.tests.test_uuidcol.rst | 7 + docs/api/sqlobject.tests.test_validation.rst | 7 + docs/api/sqlobject.tests.test_views.rst | 7 + docs/api/sqlobject.util.csvexport.rst | 7 + docs/api/sqlobject.util.csvimport.rst | 7 + docs/api/sqlobject.util.moduleloader.rst | 7 + docs/api/sqlobject.util.rst | 18 + docs/api/sqlobject.util.threadinglocal.rst | 7 + docs/api/sqlobject.versioning.rst | 15 + docs/api/sqlobject.versioning.test.rst | 15 + ...sqlobject.versioning.test.test_version.rst | 7 + docs/api/sqlobject.views.rst | 7 + docs/api/sqlobject.wsgi_middleware.rst | 7 + docs/conf.py | 353 ++++++++++++++++++ docs/genapidocs | 5 + 143 files changed, 1796 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/api/modules.rst create mode 100644 docs/api/sqlobject.boundattributes.rst create mode 100644 docs/api/sqlobject.cache.rst create mode 100644 docs/api/sqlobject.classregistry.rst create mode 100644 docs/api/sqlobject.col.rst create mode 100644 docs/api/sqlobject.compat.rst create mode 100644 docs/api/sqlobject.conftest.rst create mode 100644 docs/api/sqlobject.constraints.rst create mode 100644 docs/api/sqlobject.converters.rst create mode 100644 docs/api/sqlobject.dbconnection.rst create mode 100644 docs/api/sqlobject.dberrors.rst create mode 100644 docs/api/sqlobject.declarative.rst create mode 100644 docs/api/sqlobject.events.rst create mode 100644 docs/api/sqlobject.firebird.firebirdconnection.rst create mode 100644 docs/api/sqlobject.firebird.rst create mode 100644 docs/api/sqlobject.include.hashcol.rst create mode 100644 docs/api/sqlobject.include.rst create mode 100644 docs/api/sqlobject.include.tests.rst create mode 100644 docs/api/sqlobject.include.tests.test_hashcol.rst create mode 100644 docs/api/sqlobject.index.rst create mode 100644 docs/api/sqlobject.inheritance.iteration.rst create mode 100644 docs/api/sqlobject.inheritance.rst create mode 100644 docs/api/sqlobject.inheritance.tests.rst create mode 100644 docs/api/sqlobject.inheritance.tests.testDestroyCascade.rst create mode 100644 docs/api/sqlobject.inheritance.tests.test_aggregates.rst create mode 100644 docs/api/sqlobject.inheritance.tests.test_asdict.rst create mode 100644 docs/api/sqlobject.inheritance.tests.test_deep_inheritance.rst create mode 100644 docs/api/sqlobject.inheritance.tests.test_foreignKey.rst create mode 100644 docs/api/sqlobject.inheritance.tests.test_indexes.rst create mode 100644 docs/api/sqlobject.inheritance.tests.test_inheritance.rst create mode 100644 docs/api/sqlobject.inheritance.tests.test_inheritance_tree.rst create mode 100644 docs/api/sqlobject.joins.rst create mode 100644 docs/api/sqlobject.main.rst create mode 100644 docs/api/sqlobject.manager.command.rst create mode 100644 docs/api/sqlobject.manager.rst create mode 100644 docs/api/sqlobject.maxdb.maxdbconnection.rst create mode 100644 docs/api/sqlobject.maxdb.rst create mode 100644 docs/api/sqlobject.mssql.mssqlconnection.rst create mode 100644 docs/api/sqlobject.mssql.rst create mode 100644 docs/api/sqlobject.mysql.mysqlconnection.rst create mode 100644 docs/api/sqlobject.mysql.rst create mode 100644 docs/api/sqlobject.postgres.pgconnection.rst create mode 100644 docs/api/sqlobject.postgres.rst create mode 100644 docs/api/sqlobject.rdbhost.rdbhostconnection.rst create mode 100644 docs/api/sqlobject.rdbhost.rst create mode 100644 docs/api/sqlobject.rst create mode 100644 docs/api/sqlobject.sqlbuilder.rst create mode 100644 docs/api/sqlobject.sqlite.rst create mode 100644 docs/api/sqlobject.sqlite.sqliteconnection.rst create mode 100644 docs/api/sqlobject.sresults.rst create mode 100644 docs/api/sqlobject.styles.rst create mode 100644 docs/api/sqlobject.sybase.rst create mode 100644 docs/api/sqlobject.sybase.sybaseconnection.rst create mode 100644 docs/api/sqlobject.tests.dbtest.rst create mode 100644 docs/api/sqlobject.tests.rst create mode 100644 docs/api/sqlobject.tests.test_ForeignKey.rst create mode 100644 docs/api/sqlobject.tests.test_NoneValuedResultItem.rst create mode 100644 docs/api/sqlobject.tests.test_SQLMultipleJoin.rst create mode 100644 docs/api/sqlobject.tests.test_SQLRelatedJoin.rst create mode 100644 docs/api/sqlobject.tests.test_SingleJoin.rst create mode 100644 docs/api/sqlobject.tests.test_aggregates.rst create mode 100644 docs/api/sqlobject.tests.test_aliases.rst create mode 100644 docs/api/sqlobject.tests.test_asdict.rst create mode 100644 docs/api/sqlobject.tests.test_auto.rst create mode 100644 docs/api/sqlobject.tests.test_basic.rst create mode 100644 docs/api/sqlobject.tests.test_blob.rst create mode 100644 docs/api/sqlobject.tests.test_boundattributes.rst create mode 100644 docs/api/sqlobject.tests.test_cache.rst create mode 100644 docs/api/sqlobject.tests.test_class_hash.rst create mode 100644 docs/api/sqlobject.tests.test_columns_order.rst create mode 100644 docs/api/sqlobject.tests.test_combining_joins.rst create mode 100644 docs/api/sqlobject.tests.test_comparison.rst create mode 100644 docs/api/sqlobject.tests.test_complex_sorting.rst create mode 100644 docs/api/sqlobject.tests.test_constraints.rst create mode 100644 docs/api/sqlobject.tests.test_converters.rst create mode 100644 docs/api/sqlobject.tests.test_create_drop.rst create mode 100644 docs/api/sqlobject.tests.test_csvexport.rst create mode 100644 docs/api/sqlobject.tests.test_cyclic_reference.rst create mode 100644 docs/api/sqlobject.tests.test_datetime.rst create mode 100644 docs/api/sqlobject.tests.test_decimal.rst create mode 100644 docs/api/sqlobject.tests.test_declarative.rst create mode 100644 docs/api/sqlobject.tests.test_default_style.rst create mode 100644 docs/api/sqlobject.tests.test_delete.rst create mode 100644 docs/api/sqlobject.tests.test_distinct.rst create mode 100644 docs/api/sqlobject.tests.test_empty.rst create mode 100644 docs/api/sqlobject.tests.test_enum.rst create mode 100644 docs/api/sqlobject.tests.test_events.rst create mode 100644 docs/api/sqlobject.tests.test_exceptions.rst create mode 100644 docs/api/sqlobject.tests.test_expire.rst create mode 100644 docs/api/sqlobject.tests.test_groupBy.rst create mode 100644 docs/api/sqlobject.tests.test_identity.rst create mode 100644 docs/api/sqlobject.tests.test_indexes.rst create mode 100644 docs/api/sqlobject.tests.test_inheritance.rst create mode 100644 docs/api/sqlobject.tests.test_joins.rst create mode 100644 docs/api/sqlobject.tests.test_joins_conditional.rst create mode 100644 docs/api/sqlobject.tests.test_jsonbcol.rst create mode 100644 docs/api/sqlobject.tests.test_jsoncol.rst create mode 100644 docs/api/sqlobject.tests.test_lazy.rst create mode 100644 docs/api/sqlobject.tests.test_md5.rst create mode 100644 docs/api/sqlobject.tests.test_mysql.rst create mode 100644 docs/api/sqlobject.tests.test_new_joins.rst create mode 100644 docs/api/sqlobject.tests.test_parse_uri.rst create mode 100644 docs/api/sqlobject.tests.test_paste.rst create mode 100644 docs/api/sqlobject.tests.test_perConnection.rst create mode 100644 docs/api/sqlobject.tests.test_pickle.rst create mode 100644 docs/api/sqlobject.tests.test_picklecol.rst create mode 100644 docs/api/sqlobject.tests.test_postgres.rst create mode 100644 docs/api/sqlobject.tests.test_reparent_sqlmeta.rst create mode 100644 docs/api/sqlobject.tests.test_schema.rst create mode 100644 docs/api/sqlobject.tests.test_select.rst create mode 100644 docs/api/sqlobject.tests.test_select_through.rst create mode 100644 docs/api/sqlobject.tests.test_setters.rst create mode 100644 docs/api/sqlobject.tests.test_slice.rst create mode 100644 docs/api/sqlobject.tests.test_sorting.rst create mode 100644 docs/api/sqlobject.tests.test_sqlbuilder.rst create mode 100644 docs/api/sqlobject.tests.test_sqlbuilder_dbspecific.rst create mode 100644 docs/api/sqlobject.tests.test_sqlbuilder_importproxy.rst create mode 100644 docs/api/sqlobject.tests.test_sqlbuilder_joins_instances.rst create mode 100644 docs/api/sqlobject.tests.test_sqlite.rst create mode 100644 docs/api/sqlobject.tests.test_sqlmeta_idName.rst create mode 100644 docs/api/sqlobject.tests.test_sqlobject_admin.rst create mode 100644 docs/api/sqlobject.tests.test_string_id.rst create mode 100644 docs/api/sqlobject.tests.test_style.rst create mode 100644 docs/api/sqlobject.tests.test_subqueries.rst create mode 100644 docs/api/sqlobject.tests.test_transactions.rst create mode 100644 docs/api/sqlobject.tests.test_unicode.rst create mode 100644 docs/api/sqlobject.tests.test_uuidcol.rst create mode 100644 docs/api/sqlobject.tests.test_validation.rst create mode 100644 docs/api/sqlobject.tests.test_views.rst create mode 100644 docs/api/sqlobject.util.csvexport.rst create mode 100644 docs/api/sqlobject.util.csvimport.rst create mode 100644 docs/api/sqlobject.util.moduleloader.rst create mode 100644 docs/api/sqlobject.util.rst create mode 100644 docs/api/sqlobject.util.threadinglocal.rst create mode 100644 docs/api/sqlobject.versioning.rst create mode 100644 docs/api/sqlobject.versioning.test.rst create mode 100644 docs/api/sqlobject.versioning.test.test_version.rst create mode 100644 docs/api/sqlobject.views.rst create mode 100644 docs/api/sqlobject.wsgi_middleware.rst create mode 100644 docs/conf.py create mode 100755 docs/genapidocs diff --git a/docs/.gitignore b/docs/.gitignore index 59370209..cf1f956c 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 00000000..51881428 --- /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 ' where 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 00000000..656ed229 --- /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 00000000..1518f8da --- /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 00000000..6c74d5be --- /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 00000000..08824917 --- /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 00000000..5282fc2f --- /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 00000000..cdb4f6dd --- /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 00000000..8e564281 --- /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 00000000..ad39272b --- /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 00000000..82b5cff7 --- /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 00000000..6a6adc35 --- /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 00000000..3035746a --- /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 00000000..9cc7e9bd --- /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 00000000..8c33239d --- /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 00000000..6fdf26e9 --- /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 00000000..78cec9ae --- /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 00000000..76396aa4 --- /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 00000000..62086bfc --- /dev/null +++ b/docs/api/sqlobject.include.rst @@ -0,0 +1,22 @@ +sqlobject.include package +========================= + +.. automodule:: sqlobject.include + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + sqlobject.include.tests + +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 00000000..e17b4def --- /dev/null +++ b/docs/api/sqlobject.include.tests.rst @@ -0,0 +1,15 @@ +sqlobject.include.tests package +=============================== + +.. automodule:: sqlobject.include.tests + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + + sqlobject.include.tests.test_hashcol + diff --git a/docs/api/sqlobject.include.tests.test_hashcol.rst b/docs/api/sqlobject.include.tests.test_hashcol.rst new file mode 100644 index 00000000..99c80d9e --- /dev/null +++ b/docs/api/sqlobject.include.tests.test_hashcol.rst @@ -0,0 +1,7 @@ +sqlobject.include.tests.test_hashcol module +=========================================== + +.. automodule:: sqlobject.include.tests.test_hashcol + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.index.rst b/docs/api/sqlobject.index.rst new file mode 100644 index 00000000..bc96433c --- /dev/null +++ b/docs/api/sqlobject.index.rst @@ -0,0 +1,7 @@ +sqlobject.index module +====================== + +.. automodule:: sqlobject.index + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.inheritance.iteration.rst b/docs/api/sqlobject.inheritance.iteration.rst new file mode 100644 index 00000000..0e9538f8 --- /dev/null +++ b/docs/api/sqlobject.inheritance.iteration.rst @@ -0,0 +1,7 @@ +sqlobject.inheritance.iteration module +====================================== + +.. automodule:: sqlobject.inheritance.iteration + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.inheritance.rst b/docs/api/sqlobject.inheritance.rst new file mode 100644 index 00000000..7ab19a77 --- /dev/null +++ b/docs/api/sqlobject.inheritance.rst @@ -0,0 +1,22 @@ +sqlobject.inheritance package +============================= + +.. automodule:: sqlobject.inheritance + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + sqlobject.inheritance.tests + +Submodules +---------- + +.. toctree:: + + sqlobject.inheritance.iteration + diff --git a/docs/api/sqlobject.inheritance.tests.rst b/docs/api/sqlobject.inheritance.tests.rst new file mode 100644 index 00000000..fe36e3e9 --- /dev/null +++ b/docs/api/sqlobject.inheritance.tests.rst @@ -0,0 +1,22 @@ +sqlobject.inheritance.tests package +=================================== + +.. automodule:: sqlobject.inheritance.tests + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + + sqlobject.inheritance.tests.testDestroyCascade + sqlobject.inheritance.tests.test_aggregates + sqlobject.inheritance.tests.test_asdict + sqlobject.inheritance.tests.test_deep_inheritance + sqlobject.inheritance.tests.test_foreignKey + sqlobject.inheritance.tests.test_indexes + sqlobject.inheritance.tests.test_inheritance + sqlobject.inheritance.tests.test_inheritance_tree + diff --git a/docs/api/sqlobject.inheritance.tests.testDestroyCascade.rst b/docs/api/sqlobject.inheritance.tests.testDestroyCascade.rst new file mode 100644 index 00000000..7dc60f6c --- /dev/null +++ b/docs/api/sqlobject.inheritance.tests.testDestroyCascade.rst @@ -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.rst b/docs/api/sqlobject.inheritance.tests.test_aggregates.rst new file mode 100644 index 00000000..ee01f6b6 --- /dev/null +++ b/docs/api/sqlobject.inheritance.tests.test_aggregates.rst @@ -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.rst b/docs/api/sqlobject.inheritance.tests.test_asdict.rst new file mode 100644 index 00000000..ff95591f --- /dev/null +++ b/docs/api/sqlobject.inheritance.tests.test_asdict.rst @@ -0,0 +1,7 @@ +sqlobject.inheritance.tests.test_asdict module +============================================== + +.. automodule:: sqlobject.inheritance.tests.test_asdict + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.inheritance.tests.test_deep_inheritance.rst b/docs/api/sqlobject.inheritance.tests.test_deep_inheritance.rst new file mode 100644 index 00000000..ed4bf269 --- /dev/null +++ b/docs/api/sqlobject.inheritance.tests.test_deep_inheritance.rst @@ -0,0 +1,7 @@ +sqlobject.inheritance.tests.test_deep_inheritance module +======================================================== + +.. automodule:: sqlobject.inheritance.tests.test_deep_inheritance + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.inheritance.tests.test_foreignKey.rst b/docs/api/sqlobject.inheritance.tests.test_foreignKey.rst new file mode 100644 index 00000000..e3f09426 --- /dev/null +++ b/docs/api/sqlobject.inheritance.tests.test_foreignKey.rst @@ -0,0 +1,7 @@ +sqlobject.inheritance.tests.test_foreignKey module +================================================== + +.. automodule:: sqlobject.inheritance.tests.test_foreignKey + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.inheritance.tests.test_indexes.rst b/docs/api/sqlobject.inheritance.tests.test_indexes.rst new file mode 100644 index 00000000..b2e8d5e6 --- /dev/null +++ b/docs/api/sqlobject.inheritance.tests.test_indexes.rst @@ -0,0 +1,7 @@ +sqlobject.inheritance.tests.test_indexes module +=============================================== + +.. automodule:: sqlobject.inheritance.tests.test_indexes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.inheritance.tests.test_inheritance.rst b/docs/api/sqlobject.inheritance.tests.test_inheritance.rst new file mode 100644 index 00000000..a0c8e080 --- /dev/null +++ b/docs/api/sqlobject.inheritance.tests.test_inheritance.rst @@ -0,0 +1,7 @@ +sqlobject.inheritance.tests.test_inheritance module +=================================================== + +.. automodule:: sqlobject.inheritance.tests.test_inheritance + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.inheritance.tests.test_inheritance_tree.rst b/docs/api/sqlobject.inheritance.tests.test_inheritance_tree.rst new file mode 100644 index 00000000..b9224cca --- /dev/null +++ b/docs/api/sqlobject.inheritance.tests.test_inheritance_tree.rst @@ -0,0 +1,7 @@ +sqlobject.inheritance.tests.test_inheritance_tree module +======================================================== + +.. automodule:: sqlobject.inheritance.tests.test_inheritance_tree + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.joins.rst b/docs/api/sqlobject.joins.rst new file mode 100644 index 00000000..70e43b04 --- /dev/null +++ b/docs/api/sqlobject.joins.rst @@ -0,0 +1,7 @@ +sqlobject.joins module +====================== + +.. automodule:: sqlobject.joins + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.main.rst b/docs/api/sqlobject.main.rst new file mode 100644 index 00000000..b4de5566 --- /dev/null +++ b/docs/api/sqlobject.main.rst @@ -0,0 +1,7 @@ +sqlobject.main module +===================== + +.. automodule:: sqlobject.main + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.manager.command.rst b/docs/api/sqlobject.manager.command.rst new file mode 100644 index 00000000..bae2b682 --- /dev/null +++ b/docs/api/sqlobject.manager.command.rst @@ -0,0 +1,7 @@ +sqlobject.manager.command module +================================ + +.. automodule:: sqlobject.manager.command + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.manager.rst b/docs/api/sqlobject.manager.rst new file mode 100644 index 00000000..3a8c8a81 --- /dev/null +++ b/docs/api/sqlobject.manager.rst @@ -0,0 +1,15 @@ +sqlobject.manager package +========================= + +.. automodule:: sqlobject.manager + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + + sqlobject.manager.command + diff --git a/docs/api/sqlobject.maxdb.maxdbconnection.rst b/docs/api/sqlobject.maxdb.maxdbconnection.rst new file mode 100644 index 00000000..1a6490ea --- /dev/null +++ b/docs/api/sqlobject.maxdb.maxdbconnection.rst @@ -0,0 +1,7 @@ +sqlobject.maxdb.maxdbconnection module +====================================== + +.. automodule:: sqlobject.maxdb.maxdbconnection + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.maxdb.rst b/docs/api/sqlobject.maxdb.rst new file mode 100644 index 00000000..d591970e --- /dev/null +++ b/docs/api/sqlobject.maxdb.rst @@ -0,0 +1,15 @@ +sqlobject.maxdb package +======================= + +.. automodule:: sqlobject.maxdb + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + + sqlobject.maxdb.maxdbconnection + diff --git a/docs/api/sqlobject.mssql.mssqlconnection.rst b/docs/api/sqlobject.mssql.mssqlconnection.rst new file mode 100644 index 00000000..ffcc0023 --- /dev/null +++ b/docs/api/sqlobject.mssql.mssqlconnection.rst @@ -0,0 +1,7 @@ +sqlobject.mssql.mssqlconnection module +====================================== + +.. automodule:: sqlobject.mssql.mssqlconnection + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.mssql.rst b/docs/api/sqlobject.mssql.rst new file mode 100644 index 00000000..7e622693 --- /dev/null +++ b/docs/api/sqlobject.mssql.rst @@ -0,0 +1,15 @@ +sqlobject.mssql package +======================= + +.. automodule:: sqlobject.mssql + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + + sqlobject.mssql.mssqlconnection + diff --git a/docs/api/sqlobject.mysql.mysqlconnection.rst b/docs/api/sqlobject.mysql.mysqlconnection.rst new file mode 100644 index 00000000..3e5a9ef8 --- /dev/null +++ b/docs/api/sqlobject.mysql.mysqlconnection.rst @@ -0,0 +1,7 @@ +sqlobject.mysql.mysqlconnection module +====================================== + +.. automodule:: sqlobject.mysql.mysqlconnection + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.mysql.rst b/docs/api/sqlobject.mysql.rst new file mode 100644 index 00000000..7e69a9e2 --- /dev/null +++ b/docs/api/sqlobject.mysql.rst @@ -0,0 +1,15 @@ +sqlobject.mysql package +======================= + +.. automodule:: sqlobject.mysql + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + + sqlobject.mysql.mysqlconnection + diff --git a/docs/api/sqlobject.postgres.pgconnection.rst b/docs/api/sqlobject.postgres.pgconnection.rst new file mode 100644 index 00000000..854104d5 --- /dev/null +++ b/docs/api/sqlobject.postgres.pgconnection.rst @@ -0,0 +1,7 @@ +sqlobject.postgres.pgconnection module +====================================== + +.. automodule:: sqlobject.postgres.pgconnection + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.postgres.rst b/docs/api/sqlobject.postgres.rst new file mode 100644 index 00000000..ad93e75d --- /dev/null +++ b/docs/api/sqlobject.postgres.rst @@ -0,0 +1,15 @@ +sqlobject.postgres package +========================== + +.. automodule:: sqlobject.postgres + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + + sqlobject.postgres.pgconnection + diff --git a/docs/api/sqlobject.rdbhost.rdbhostconnection.rst b/docs/api/sqlobject.rdbhost.rdbhostconnection.rst new file mode 100644 index 00000000..3f8e7379 --- /dev/null +++ b/docs/api/sqlobject.rdbhost.rdbhostconnection.rst @@ -0,0 +1,7 @@ +sqlobject.rdbhost.rdbhostconnection module +========================================== + +.. automodule:: sqlobject.rdbhost.rdbhostconnection + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.rdbhost.rst b/docs/api/sqlobject.rdbhost.rst new file mode 100644 index 00000000..19f0020d --- /dev/null +++ b/docs/api/sqlobject.rdbhost.rst @@ -0,0 +1,15 @@ +sqlobject.rdbhost package +========================= + +.. automodule:: sqlobject.rdbhost + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + + sqlobject.rdbhost.rdbhostconnection + diff --git a/docs/api/sqlobject.rst b/docs/api/sqlobject.rst new file mode 100644 index 00000000..1695715e --- /dev/null +++ b/docs/api/sqlobject.rst @@ -0,0 +1,54 @@ +sqlobject package +================= + +.. automodule:: sqlobject + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + sqlobject.firebird + sqlobject.include + sqlobject.inheritance + sqlobject.manager + sqlobject.maxdb + sqlobject.mssql + sqlobject.mysql + sqlobject.postgres + sqlobject.rdbhost + sqlobject.sqlite + sqlobject.sybase + sqlobject.tests + sqlobject.util + sqlobject.versioning + +Submodules +---------- + +.. toctree:: + + sqlobject.boundattributes + sqlobject.cache + sqlobject.classregistry + sqlobject.col + sqlobject.compat + sqlobject.conftest + sqlobject.constraints + sqlobject.converters + sqlobject.dbconnection + sqlobject.dberrors + sqlobject.declarative + sqlobject.events + sqlobject.index + sqlobject.joins + sqlobject.main + sqlobject.sqlbuilder + sqlobject.sresults + sqlobject.styles + sqlobject.views + sqlobject.wsgi_middleware + diff --git a/docs/api/sqlobject.sqlbuilder.rst b/docs/api/sqlobject.sqlbuilder.rst new file mode 100644 index 00000000..bd21c086 --- /dev/null +++ b/docs/api/sqlobject.sqlbuilder.rst @@ -0,0 +1,7 @@ +sqlobject.sqlbuilder module +=========================== + +.. automodule:: sqlobject.sqlbuilder + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.sqlite.rst b/docs/api/sqlobject.sqlite.rst new file mode 100644 index 00000000..f62364ef --- /dev/null +++ b/docs/api/sqlobject.sqlite.rst @@ -0,0 +1,15 @@ +sqlobject.sqlite package +======================== + +.. automodule:: sqlobject.sqlite + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + + sqlobject.sqlite.sqliteconnection + diff --git a/docs/api/sqlobject.sqlite.sqliteconnection.rst b/docs/api/sqlobject.sqlite.sqliteconnection.rst new file mode 100644 index 00000000..0ce1763a --- /dev/null +++ b/docs/api/sqlobject.sqlite.sqliteconnection.rst @@ -0,0 +1,7 @@ +sqlobject.sqlite.sqliteconnection module +======================================== + +.. automodule:: sqlobject.sqlite.sqliteconnection + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.sresults.rst b/docs/api/sqlobject.sresults.rst new file mode 100644 index 00000000..690de42e --- /dev/null +++ b/docs/api/sqlobject.sresults.rst @@ -0,0 +1,7 @@ +sqlobject.sresults module +========================= + +.. automodule:: sqlobject.sresults + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.styles.rst b/docs/api/sqlobject.styles.rst new file mode 100644 index 00000000..04aeb8c8 --- /dev/null +++ b/docs/api/sqlobject.styles.rst @@ -0,0 +1,7 @@ +sqlobject.styles module +======================= + +.. automodule:: sqlobject.styles + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.sybase.rst b/docs/api/sqlobject.sybase.rst new file mode 100644 index 00000000..b5d5aef8 --- /dev/null +++ b/docs/api/sqlobject.sybase.rst @@ -0,0 +1,15 @@ +sqlobject.sybase package +======================== + +.. automodule:: sqlobject.sybase + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + + sqlobject.sybase.sybaseconnection + diff --git a/docs/api/sqlobject.sybase.sybaseconnection.rst b/docs/api/sqlobject.sybase.sybaseconnection.rst new file mode 100644 index 00000000..3cdf4c02 --- /dev/null +++ b/docs/api/sqlobject.sybase.sybaseconnection.rst @@ -0,0 +1,7 @@ +sqlobject.sybase.sybaseconnection module +======================================== + +.. automodule:: sqlobject.sybase.sybaseconnection + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.dbtest.rst b/docs/api/sqlobject.tests.dbtest.rst new file mode 100644 index 00000000..b6fb5132 --- /dev/null +++ b/docs/api/sqlobject.tests.dbtest.rst @@ -0,0 +1,7 @@ +sqlobject.tests.dbtest module +============================= + +.. automodule:: sqlobject.tests.dbtest + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.rst b/docs/api/sqlobject.tests.rst new file mode 100644 index 00000000..98f38cd6 --- /dev/null +++ b/docs/api/sqlobject.tests.rst @@ -0,0 +1,89 @@ +sqlobject.tests package +======================= + +.. automodule:: sqlobject.tests + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + + sqlobject.tests.dbtest + sqlobject.tests.test_ForeignKey + sqlobject.tests.test_NoneValuedResultItem + sqlobject.tests.test_SQLMultipleJoin + sqlobject.tests.test_SQLRelatedJoin + sqlobject.tests.test_SingleJoin + sqlobject.tests.test_aggregates + sqlobject.tests.test_aliases + sqlobject.tests.test_asdict + sqlobject.tests.test_auto + sqlobject.tests.test_basic + sqlobject.tests.test_blob + sqlobject.tests.test_boundattributes + sqlobject.tests.test_cache + sqlobject.tests.test_class_hash + sqlobject.tests.test_columns_order + sqlobject.tests.test_combining_joins + sqlobject.tests.test_comparison + sqlobject.tests.test_complex_sorting + sqlobject.tests.test_constraints + sqlobject.tests.test_converters + sqlobject.tests.test_create_drop + sqlobject.tests.test_csvexport + sqlobject.tests.test_cyclic_reference + sqlobject.tests.test_datetime + sqlobject.tests.test_decimal + sqlobject.tests.test_declarative + sqlobject.tests.test_default_style + sqlobject.tests.test_delete + sqlobject.tests.test_distinct + sqlobject.tests.test_empty + sqlobject.tests.test_enum + sqlobject.tests.test_events + sqlobject.tests.test_exceptions + sqlobject.tests.test_expire + sqlobject.tests.test_groupBy + sqlobject.tests.test_identity + sqlobject.tests.test_indexes + sqlobject.tests.test_inheritance + sqlobject.tests.test_joins + sqlobject.tests.test_joins_conditional + sqlobject.tests.test_jsonbcol + sqlobject.tests.test_jsoncol + sqlobject.tests.test_lazy + sqlobject.tests.test_md5 + sqlobject.tests.test_mysql + sqlobject.tests.test_new_joins + sqlobject.tests.test_parse_uri + sqlobject.tests.test_paste + sqlobject.tests.test_perConnection + sqlobject.tests.test_pickle + sqlobject.tests.test_picklecol + sqlobject.tests.test_postgres + sqlobject.tests.test_reparent_sqlmeta + sqlobject.tests.test_schema + sqlobject.tests.test_select + sqlobject.tests.test_select_through + sqlobject.tests.test_setters + sqlobject.tests.test_slice + sqlobject.tests.test_sorting + sqlobject.tests.test_sqlbuilder + sqlobject.tests.test_sqlbuilder_dbspecific + sqlobject.tests.test_sqlbuilder_importproxy + sqlobject.tests.test_sqlbuilder_joins_instances + sqlobject.tests.test_sqlite + sqlobject.tests.test_sqlmeta_idName + sqlobject.tests.test_sqlobject_admin + sqlobject.tests.test_string_id + sqlobject.tests.test_style + sqlobject.tests.test_subqueries + sqlobject.tests.test_transactions + sqlobject.tests.test_unicode + sqlobject.tests.test_uuidcol + sqlobject.tests.test_validation + sqlobject.tests.test_views + diff --git a/docs/api/sqlobject.tests.test_ForeignKey.rst b/docs/api/sqlobject.tests.test_ForeignKey.rst new file mode 100644 index 00000000..a4a9dc33 --- /dev/null +++ b/docs/api/sqlobject.tests.test_ForeignKey.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_ForeignKey module +====================================== + +.. automodule:: sqlobject.tests.test_ForeignKey + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_NoneValuedResultItem.rst b/docs/api/sqlobject.tests.test_NoneValuedResultItem.rst new file mode 100644 index 00000000..9e0a01e2 --- /dev/null +++ b/docs/api/sqlobject.tests.test_NoneValuedResultItem.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_NoneValuedResultItem module +================================================ + +.. automodule:: sqlobject.tests.test_NoneValuedResultItem + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_SQLMultipleJoin.rst b/docs/api/sqlobject.tests.test_SQLMultipleJoin.rst new file mode 100644 index 00000000..c7e1ee1b --- /dev/null +++ b/docs/api/sqlobject.tests.test_SQLMultipleJoin.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_SQLMultipleJoin module +=========================================== + +.. automodule:: sqlobject.tests.test_SQLMultipleJoin + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_SQLRelatedJoin.rst b/docs/api/sqlobject.tests.test_SQLRelatedJoin.rst new file mode 100644 index 00000000..ffd4f028 --- /dev/null +++ b/docs/api/sqlobject.tests.test_SQLRelatedJoin.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_SQLRelatedJoin module +========================================== + +.. automodule:: sqlobject.tests.test_SQLRelatedJoin + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_SingleJoin.rst b/docs/api/sqlobject.tests.test_SingleJoin.rst new file mode 100644 index 00000000..2f0f52a3 --- /dev/null +++ b/docs/api/sqlobject.tests.test_SingleJoin.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_SingleJoin module +====================================== + +.. automodule:: sqlobject.tests.test_SingleJoin + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_aggregates.rst b/docs/api/sqlobject.tests.test_aggregates.rst new file mode 100644 index 00000000..c64faf15 --- /dev/null +++ b/docs/api/sqlobject.tests.test_aggregates.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_aggregates module +====================================== + +.. automodule:: sqlobject.tests.test_aggregates + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_aliases.rst b/docs/api/sqlobject.tests.test_aliases.rst new file mode 100644 index 00000000..c883b8c1 --- /dev/null +++ b/docs/api/sqlobject.tests.test_aliases.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_aliases module +=================================== + +.. automodule:: sqlobject.tests.test_aliases + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_asdict.rst b/docs/api/sqlobject.tests.test_asdict.rst new file mode 100644 index 00000000..40e4c364 --- /dev/null +++ b/docs/api/sqlobject.tests.test_asdict.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_asdict module +================================== + +.. automodule:: sqlobject.tests.test_asdict + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_auto.rst b/docs/api/sqlobject.tests.test_auto.rst new file mode 100644 index 00000000..0ea2f524 --- /dev/null +++ b/docs/api/sqlobject.tests.test_auto.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_auto module +================================ + +.. automodule:: sqlobject.tests.test_auto + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_basic.rst b/docs/api/sqlobject.tests.test_basic.rst new file mode 100644 index 00000000..fabffe60 --- /dev/null +++ b/docs/api/sqlobject.tests.test_basic.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_basic module +================================= + +.. automodule:: sqlobject.tests.test_basic + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_blob.rst b/docs/api/sqlobject.tests.test_blob.rst new file mode 100644 index 00000000..e3c67850 --- /dev/null +++ b/docs/api/sqlobject.tests.test_blob.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_blob module +================================ + +.. automodule:: sqlobject.tests.test_blob + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_boundattributes.rst b/docs/api/sqlobject.tests.test_boundattributes.rst new file mode 100644 index 00000000..a648d71c --- /dev/null +++ b/docs/api/sqlobject.tests.test_boundattributes.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_boundattributes module +=========================================== + +.. automodule:: sqlobject.tests.test_boundattributes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_cache.rst b/docs/api/sqlobject.tests.test_cache.rst new file mode 100644 index 00000000..dd344907 --- /dev/null +++ b/docs/api/sqlobject.tests.test_cache.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_cache module +================================= + +.. automodule:: sqlobject.tests.test_cache + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_class_hash.rst b/docs/api/sqlobject.tests.test_class_hash.rst new file mode 100644 index 00000000..17fc1371 --- /dev/null +++ b/docs/api/sqlobject.tests.test_class_hash.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_class_hash module +====================================== + +.. automodule:: sqlobject.tests.test_class_hash + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_columns_order.rst b/docs/api/sqlobject.tests.test_columns_order.rst new file mode 100644 index 00000000..12c5b619 --- /dev/null +++ b/docs/api/sqlobject.tests.test_columns_order.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_columns_order module +========================================= + +.. automodule:: sqlobject.tests.test_columns_order + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_combining_joins.rst b/docs/api/sqlobject.tests.test_combining_joins.rst new file mode 100644 index 00000000..7ab4faa3 --- /dev/null +++ b/docs/api/sqlobject.tests.test_combining_joins.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_combining_joins module +=========================================== + +.. automodule:: sqlobject.tests.test_combining_joins + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_comparison.rst b/docs/api/sqlobject.tests.test_comparison.rst new file mode 100644 index 00000000..f44f5ffc --- /dev/null +++ b/docs/api/sqlobject.tests.test_comparison.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_comparison module +====================================== + +.. automodule:: sqlobject.tests.test_comparison + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_complex_sorting.rst b/docs/api/sqlobject.tests.test_complex_sorting.rst new file mode 100644 index 00000000..a2f9eb8b --- /dev/null +++ b/docs/api/sqlobject.tests.test_complex_sorting.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_complex_sorting module +=========================================== + +.. automodule:: sqlobject.tests.test_complex_sorting + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_constraints.rst b/docs/api/sqlobject.tests.test_constraints.rst new file mode 100644 index 00000000..6ddd2f69 --- /dev/null +++ b/docs/api/sqlobject.tests.test_constraints.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_constraints module +======================================= + +.. automodule:: sqlobject.tests.test_constraints + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_converters.rst b/docs/api/sqlobject.tests.test_converters.rst new file mode 100644 index 00000000..fd05137e --- /dev/null +++ b/docs/api/sqlobject.tests.test_converters.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_converters module +====================================== + +.. automodule:: sqlobject.tests.test_converters + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_create_drop.rst b/docs/api/sqlobject.tests.test_create_drop.rst new file mode 100644 index 00000000..173f9608 --- /dev/null +++ b/docs/api/sqlobject.tests.test_create_drop.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_create_drop module +======================================= + +.. automodule:: sqlobject.tests.test_create_drop + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_csvexport.rst b/docs/api/sqlobject.tests.test_csvexport.rst new file mode 100644 index 00000000..26b28675 --- /dev/null +++ b/docs/api/sqlobject.tests.test_csvexport.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_csvexport module +===================================== + +.. automodule:: sqlobject.tests.test_csvexport + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_cyclic_reference.rst b/docs/api/sqlobject.tests.test_cyclic_reference.rst new file mode 100644 index 00000000..21ecd08d --- /dev/null +++ b/docs/api/sqlobject.tests.test_cyclic_reference.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_cyclic_reference module +============================================ + +.. automodule:: sqlobject.tests.test_cyclic_reference + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_datetime.rst b/docs/api/sqlobject.tests.test_datetime.rst new file mode 100644 index 00000000..e2198966 --- /dev/null +++ b/docs/api/sqlobject.tests.test_datetime.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_datetime module +==================================== + +.. automodule:: sqlobject.tests.test_datetime + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_decimal.rst b/docs/api/sqlobject.tests.test_decimal.rst new file mode 100644 index 00000000..7752caaf --- /dev/null +++ b/docs/api/sqlobject.tests.test_decimal.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_decimal module +=================================== + +.. automodule:: sqlobject.tests.test_decimal + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_declarative.rst b/docs/api/sqlobject.tests.test_declarative.rst new file mode 100644 index 00000000..2c5c2c23 --- /dev/null +++ b/docs/api/sqlobject.tests.test_declarative.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_declarative module +======================================= + +.. automodule:: sqlobject.tests.test_declarative + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_default_style.rst b/docs/api/sqlobject.tests.test_default_style.rst new file mode 100644 index 00000000..8245134b --- /dev/null +++ b/docs/api/sqlobject.tests.test_default_style.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_default_style module +========================================= + +.. automodule:: sqlobject.tests.test_default_style + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_delete.rst b/docs/api/sqlobject.tests.test_delete.rst new file mode 100644 index 00000000..65f95c8b --- /dev/null +++ b/docs/api/sqlobject.tests.test_delete.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_delete module +================================== + +.. automodule:: sqlobject.tests.test_delete + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_distinct.rst b/docs/api/sqlobject.tests.test_distinct.rst new file mode 100644 index 00000000..c7ab42ca --- /dev/null +++ b/docs/api/sqlobject.tests.test_distinct.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_distinct module +==================================== + +.. automodule:: sqlobject.tests.test_distinct + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_empty.rst b/docs/api/sqlobject.tests.test_empty.rst new file mode 100644 index 00000000..d10bc015 --- /dev/null +++ b/docs/api/sqlobject.tests.test_empty.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_empty module +================================= + +.. automodule:: sqlobject.tests.test_empty + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_enum.rst b/docs/api/sqlobject.tests.test_enum.rst new file mode 100644 index 00000000..11f97770 --- /dev/null +++ b/docs/api/sqlobject.tests.test_enum.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_enum module +================================ + +.. automodule:: sqlobject.tests.test_enum + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_events.rst b/docs/api/sqlobject.tests.test_events.rst new file mode 100644 index 00000000..d6c08997 --- /dev/null +++ b/docs/api/sqlobject.tests.test_events.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_events module +================================== + +.. automodule:: sqlobject.tests.test_events + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_exceptions.rst b/docs/api/sqlobject.tests.test_exceptions.rst new file mode 100644 index 00000000..6c92b729 --- /dev/null +++ b/docs/api/sqlobject.tests.test_exceptions.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_exceptions module +====================================== + +.. automodule:: sqlobject.tests.test_exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_expire.rst b/docs/api/sqlobject.tests.test_expire.rst new file mode 100644 index 00000000..e2d56ea9 --- /dev/null +++ b/docs/api/sqlobject.tests.test_expire.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_expire module +================================== + +.. automodule:: sqlobject.tests.test_expire + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_groupBy.rst b/docs/api/sqlobject.tests.test_groupBy.rst new file mode 100644 index 00000000..fd8cc9ff --- /dev/null +++ b/docs/api/sqlobject.tests.test_groupBy.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_groupBy module +=================================== + +.. automodule:: sqlobject.tests.test_groupBy + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_identity.rst b/docs/api/sqlobject.tests.test_identity.rst new file mode 100644 index 00000000..8e8537c4 --- /dev/null +++ b/docs/api/sqlobject.tests.test_identity.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_identity module +==================================== + +.. automodule:: sqlobject.tests.test_identity + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_indexes.rst b/docs/api/sqlobject.tests.test_indexes.rst new file mode 100644 index 00000000..f862ac8d --- /dev/null +++ b/docs/api/sqlobject.tests.test_indexes.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_indexes module +=================================== + +.. automodule:: sqlobject.tests.test_indexes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_inheritance.rst b/docs/api/sqlobject.tests.test_inheritance.rst new file mode 100644 index 00000000..2913d3a6 --- /dev/null +++ b/docs/api/sqlobject.tests.test_inheritance.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_inheritance module +======================================= + +.. automodule:: sqlobject.tests.test_inheritance + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_joins.rst b/docs/api/sqlobject.tests.test_joins.rst new file mode 100644 index 00000000..08f486eb --- /dev/null +++ b/docs/api/sqlobject.tests.test_joins.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_joins module +================================= + +.. automodule:: sqlobject.tests.test_joins + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_joins_conditional.rst b/docs/api/sqlobject.tests.test_joins_conditional.rst new file mode 100644 index 00000000..a347d30c --- /dev/null +++ b/docs/api/sqlobject.tests.test_joins_conditional.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_joins_conditional module +============================================= + +.. automodule:: sqlobject.tests.test_joins_conditional + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_jsonbcol.rst b/docs/api/sqlobject.tests.test_jsonbcol.rst new file mode 100644 index 00000000..ef8a6b86 --- /dev/null +++ b/docs/api/sqlobject.tests.test_jsonbcol.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_jsonbcol module +==================================== + +.. automodule:: sqlobject.tests.test_jsonbcol + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_jsoncol.rst b/docs/api/sqlobject.tests.test_jsoncol.rst new file mode 100644 index 00000000..93ba6fb4 --- /dev/null +++ b/docs/api/sqlobject.tests.test_jsoncol.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_jsoncol module +=================================== + +.. automodule:: sqlobject.tests.test_jsoncol + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_lazy.rst b/docs/api/sqlobject.tests.test_lazy.rst new file mode 100644 index 00000000..317b3650 --- /dev/null +++ b/docs/api/sqlobject.tests.test_lazy.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_lazy module +================================ + +.. automodule:: sqlobject.tests.test_lazy + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_md5.rst b/docs/api/sqlobject.tests.test_md5.rst new file mode 100644 index 00000000..d71f26b0 --- /dev/null +++ b/docs/api/sqlobject.tests.test_md5.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_md5 module +=============================== + +.. automodule:: sqlobject.tests.test_md5 + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_mysql.rst b/docs/api/sqlobject.tests.test_mysql.rst new file mode 100644 index 00000000..881f36db --- /dev/null +++ b/docs/api/sqlobject.tests.test_mysql.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_mysql module +================================= + +.. automodule:: sqlobject.tests.test_mysql + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_new_joins.rst b/docs/api/sqlobject.tests.test_new_joins.rst new file mode 100644 index 00000000..abff0b3f --- /dev/null +++ b/docs/api/sqlobject.tests.test_new_joins.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_new_joins module +===================================== + +.. automodule:: sqlobject.tests.test_new_joins + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_parse_uri.rst b/docs/api/sqlobject.tests.test_parse_uri.rst new file mode 100644 index 00000000..8d33ae5b --- /dev/null +++ b/docs/api/sqlobject.tests.test_parse_uri.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_parse_uri module +===================================== + +.. automodule:: sqlobject.tests.test_parse_uri + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_paste.rst b/docs/api/sqlobject.tests.test_paste.rst new file mode 100644 index 00000000..64607769 --- /dev/null +++ b/docs/api/sqlobject.tests.test_paste.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_paste module +================================= + +.. automodule:: sqlobject.tests.test_paste + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_perConnection.rst b/docs/api/sqlobject.tests.test_perConnection.rst new file mode 100644 index 00000000..d36711a0 --- /dev/null +++ b/docs/api/sqlobject.tests.test_perConnection.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_perConnection module +========================================= + +.. automodule:: sqlobject.tests.test_perConnection + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_pickle.rst b/docs/api/sqlobject.tests.test_pickle.rst new file mode 100644 index 00000000..a1540275 --- /dev/null +++ b/docs/api/sqlobject.tests.test_pickle.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_pickle module +================================== + +.. automodule:: sqlobject.tests.test_pickle + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_picklecol.rst b/docs/api/sqlobject.tests.test_picklecol.rst new file mode 100644 index 00000000..be2c174f --- /dev/null +++ b/docs/api/sqlobject.tests.test_picklecol.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_picklecol module +===================================== + +.. automodule:: sqlobject.tests.test_picklecol + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_postgres.rst b/docs/api/sqlobject.tests.test_postgres.rst new file mode 100644 index 00000000..393803db --- /dev/null +++ b/docs/api/sqlobject.tests.test_postgres.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_postgres module +==================================== + +.. automodule:: sqlobject.tests.test_postgres + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_reparent_sqlmeta.rst b/docs/api/sqlobject.tests.test_reparent_sqlmeta.rst new file mode 100644 index 00000000..60a316e9 --- /dev/null +++ b/docs/api/sqlobject.tests.test_reparent_sqlmeta.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_reparent_sqlmeta module +============================================ + +.. automodule:: sqlobject.tests.test_reparent_sqlmeta + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_schema.rst b/docs/api/sqlobject.tests.test_schema.rst new file mode 100644 index 00000000..b5a5c6bc --- /dev/null +++ b/docs/api/sqlobject.tests.test_schema.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_schema module +================================== + +.. automodule:: sqlobject.tests.test_schema + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_select.rst b/docs/api/sqlobject.tests.test_select.rst new file mode 100644 index 00000000..f3bda2ac --- /dev/null +++ b/docs/api/sqlobject.tests.test_select.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_select module +================================== + +.. automodule:: sqlobject.tests.test_select + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_select_through.rst b/docs/api/sqlobject.tests.test_select_through.rst new file mode 100644 index 00000000..8a1c7a92 --- /dev/null +++ b/docs/api/sqlobject.tests.test_select_through.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_select_through module +========================================== + +.. automodule:: sqlobject.tests.test_select_through + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_setters.rst b/docs/api/sqlobject.tests.test_setters.rst new file mode 100644 index 00000000..110c04d3 --- /dev/null +++ b/docs/api/sqlobject.tests.test_setters.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_setters module +=================================== + +.. automodule:: sqlobject.tests.test_setters + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_slice.rst b/docs/api/sqlobject.tests.test_slice.rst new file mode 100644 index 00000000..7486e203 --- /dev/null +++ b/docs/api/sqlobject.tests.test_slice.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_slice module +================================= + +.. automodule:: sqlobject.tests.test_slice + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_sorting.rst b/docs/api/sqlobject.tests.test_sorting.rst new file mode 100644 index 00000000..f15e9fea --- /dev/null +++ b/docs/api/sqlobject.tests.test_sorting.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_sorting module +=================================== + +.. automodule:: sqlobject.tests.test_sorting + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_sqlbuilder.rst b/docs/api/sqlobject.tests.test_sqlbuilder.rst new file mode 100644 index 00000000..18f50c13 --- /dev/null +++ b/docs/api/sqlobject.tests.test_sqlbuilder.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_sqlbuilder module +====================================== + +.. automodule:: sqlobject.tests.test_sqlbuilder + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_sqlbuilder_dbspecific.rst b/docs/api/sqlobject.tests.test_sqlbuilder_dbspecific.rst new file mode 100644 index 00000000..27b8b45a --- /dev/null +++ b/docs/api/sqlobject.tests.test_sqlbuilder_dbspecific.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_sqlbuilder_dbspecific module +================================================= + +.. automodule:: sqlobject.tests.test_sqlbuilder_dbspecific + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_sqlbuilder_importproxy.rst b/docs/api/sqlobject.tests.test_sqlbuilder_importproxy.rst new file mode 100644 index 00000000..45d83c04 --- /dev/null +++ b/docs/api/sqlobject.tests.test_sqlbuilder_importproxy.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_sqlbuilder_importproxy module +================================================== + +.. automodule:: sqlobject.tests.test_sqlbuilder_importproxy + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_sqlbuilder_joins_instances.rst b/docs/api/sqlobject.tests.test_sqlbuilder_joins_instances.rst new file mode 100644 index 00000000..0789abd1 --- /dev/null +++ b/docs/api/sqlobject.tests.test_sqlbuilder_joins_instances.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_sqlbuilder_joins_instances module +====================================================== + +.. automodule:: sqlobject.tests.test_sqlbuilder_joins_instances + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_sqlite.rst b/docs/api/sqlobject.tests.test_sqlite.rst new file mode 100644 index 00000000..d6004569 --- /dev/null +++ b/docs/api/sqlobject.tests.test_sqlite.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_sqlite module +================================== + +.. automodule:: sqlobject.tests.test_sqlite + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_sqlmeta_idName.rst b/docs/api/sqlobject.tests.test_sqlmeta_idName.rst new file mode 100644 index 00000000..c051696c --- /dev/null +++ b/docs/api/sqlobject.tests.test_sqlmeta_idName.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_sqlmeta_idName module +========================================== + +.. automodule:: sqlobject.tests.test_sqlmeta_idName + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_sqlobject_admin.rst b/docs/api/sqlobject.tests.test_sqlobject_admin.rst new file mode 100644 index 00000000..71d3114a --- /dev/null +++ b/docs/api/sqlobject.tests.test_sqlobject_admin.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_sqlobject_admin module +=========================================== + +.. automodule:: sqlobject.tests.test_sqlobject_admin + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_string_id.rst b/docs/api/sqlobject.tests.test_string_id.rst new file mode 100644 index 00000000..70116477 --- /dev/null +++ b/docs/api/sqlobject.tests.test_string_id.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_string_id module +===================================== + +.. automodule:: sqlobject.tests.test_string_id + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_style.rst b/docs/api/sqlobject.tests.test_style.rst new file mode 100644 index 00000000..202721a4 --- /dev/null +++ b/docs/api/sqlobject.tests.test_style.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_style module +================================= + +.. automodule:: sqlobject.tests.test_style + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_subqueries.rst b/docs/api/sqlobject.tests.test_subqueries.rst new file mode 100644 index 00000000..97ee2874 --- /dev/null +++ b/docs/api/sqlobject.tests.test_subqueries.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_subqueries module +====================================== + +.. automodule:: sqlobject.tests.test_subqueries + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_transactions.rst b/docs/api/sqlobject.tests.test_transactions.rst new file mode 100644 index 00000000..1e2cd7e5 --- /dev/null +++ b/docs/api/sqlobject.tests.test_transactions.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_transactions module +======================================== + +.. automodule:: sqlobject.tests.test_transactions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_unicode.rst b/docs/api/sqlobject.tests.test_unicode.rst new file mode 100644 index 00000000..7ac2e758 --- /dev/null +++ b/docs/api/sqlobject.tests.test_unicode.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_unicode module +=================================== + +.. automodule:: sqlobject.tests.test_unicode + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_uuidcol.rst b/docs/api/sqlobject.tests.test_uuidcol.rst new file mode 100644 index 00000000..f6e30079 --- /dev/null +++ b/docs/api/sqlobject.tests.test_uuidcol.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_uuidcol module +=================================== + +.. automodule:: sqlobject.tests.test_uuidcol + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_validation.rst b/docs/api/sqlobject.tests.test_validation.rst new file mode 100644 index 00000000..c0240304 --- /dev/null +++ b/docs/api/sqlobject.tests.test_validation.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_validation module +====================================== + +.. automodule:: sqlobject.tests.test_validation + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.tests.test_views.rst b/docs/api/sqlobject.tests.test_views.rst new file mode 100644 index 00000000..be986715 --- /dev/null +++ b/docs/api/sqlobject.tests.test_views.rst @@ -0,0 +1,7 @@ +sqlobject.tests.test_views module +================================= + +.. automodule:: sqlobject.tests.test_views + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.util.csvexport.rst b/docs/api/sqlobject.util.csvexport.rst new file mode 100644 index 00000000..25a3cb86 --- /dev/null +++ b/docs/api/sqlobject.util.csvexport.rst @@ -0,0 +1,7 @@ +sqlobject.util.csvexport module +=============================== + +.. automodule:: sqlobject.util.csvexport + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.util.csvimport.rst b/docs/api/sqlobject.util.csvimport.rst new file mode 100644 index 00000000..415b518c --- /dev/null +++ b/docs/api/sqlobject.util.csvimport.rst @@ -0,0 +1,7 @@ +sqlobject.util.csvimport module +=============================== + +.. automodule:: sqlobject.util.csvimport + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.util.moduleloader.rst b/docs/api/sqlobject.util.moduleloader.rst new file mode 100644 index 00000000..f262edad --- /dev/null +++ b/docs/api/sqlobject.util.moduleloader.rst @@ -0,0 +1,7 @@ +sqlobject.util.moduleloader module +================================== + +.. automodule:: sqlobject.util.moduleloader + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.util.rst b/docs/api/sqlobject.util.rst new file mode 100644 index 00000000..9f5c1b38 --- /dev/null +++ b/docs/api/sqlobject.util.rst @@ -0,0 +1,18 @@ +sqlobject.util package +====================== + +.. automodule:: sqlobject.util + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + + sqlobject.util.csvexport + sqlobject.util.csvimport + sqlobject.util.moduleloader + sqlobject.util.threadinglocal + diff --git a/docs/api/sqlobject.util.threadinglocal.rst b/docs/api/sqlobject.util.threadinglocal.rst new file mode 100644 index 00000000..dddba4d2 --- /dev/null +++ b/docs/api/sqlobject.util.threadinglocal.rst @@ -0,0 +1,7 @@ +sqlobject.util.threadinglocal module +==================================== + +.. automodule:: sqlobject.util.threadinglocal + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.versioning.rst b/docs/api/sqlobject.versioning.rst new file mode 100644 index 00000000..852d3e95 --- /dev/null +++ b/docs/api/sqlobject.versioning.rst @@ -0,0 +1,15 @@ +sqlobject.versioning package +============================ + +.. automodule:: sqlobject.versioning + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + sqlobject.versioning.test + diff --git a/docs/api/sqlobject.versioning.test.rst b/docs/api/sqlobject.versioning.test.rst new file mode 100644 index 00000000..6f9ea366 --- /dev/null +++ b/docs/api/sqlobject.versioning.test.rst @@ -0,0 +1,15 @@ +sqlobject.versioning.test package +================================= + +.. automodule:: sqlobject.versioning.test + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + + sqlobject.versioning.test.test_version + diff --git a/docs/api/sqlobject.versioning.test.test_version.rst b/docs/api/sqlobject.versioning.test.test_version.rst new file mode 100644 index 00000000..e2b21e1b --- /dev/null +++ b/docs/api/sqlobject.versioning.test.test_version.rst @@ -0,0 +1,7 @@ +sqlobject.versioning.test.test_version module +============================================= + +.. automodule:: sqlobject.versioning.test.test_version + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.views.rst b/docs/api/sqlobject.views.rst new file mode 100644 index 00000000..d0a30c58 --- /dev/null +++ b/docs/api/sqlobject.views.rst @@ -0,0 +1,7 @@ +sqlobject.views module +====================== + +.. automodule:: sqlobject.views + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/sqlobject.wsgi_middleware.rst b/docs/api/sqlobject.wsgi_middleware.rst new file mode 100644 index 00000000..635e3e76 --- /dev/null +++ b/docs/api/sqlobject.wsgi_middleware.rst @@ -0,0 +1,7 @@ +sqlobject.wsgi_middleware module +================================ + +.. automodule:: sqlobject.wsgi_middleware + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..edc2836a --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,353 @@ +# -*- coding: utf-8 -*- +# +# SQLObject documentation build configuration file, created by +# sphinx-quickstart. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# import sys +# import os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.viewcode', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'SQLObject' +authors = u'Ian Bicking and contributors' +copyright = u'2004-2015, ' + authors + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '3.0' +# The full version, including alpha/beta/rc tags. +release = '3.0.0a0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = 'en' + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'SQLObjectdoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # 'preamble': '', + + # Latex figure (float) alignment + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'SQLObject.tex', u'SQLObject Documentation', + authors, 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'sqlobject', u'SQLObject Documentation', + [authors], 1) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'SQLObject', u'SQLObject Documentation', + authors, 'SQLObject', + 'Object-relational mapper for Python.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + + +# -- Options for Epub output ---------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = u'SQLObject' +epub_author = authors +epub_publisher = authors +epub_copyright = copyright + +# The basename for the epub file. It defaults to the project name. +# epub_basename = u'SQLObject' + +# The HTML theme for the epub output. +# Since the default themes are not optimized +# for small screen space, using the same theme for HTML and epub output is +# usually not wise. This defaults to 'epub', a theme designed to save visual +# space. +# epub_theme = 'epub' + +# The language of the text. It defaults to the language option +# or 'en' if the language is not set. +# epub_language = '' + +# The scheme of the identifier. Typical schemes are ISBN or URL. +# epub_scheme = '' + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# epub_identifier = '' + +# A unique identification for the text. +# epub_uid = '' + +# A tuple containing the cover image and cover page html template filenames. +# epub_cover = () + +# A sequence of (type, uri, title) tuples for the guide element of content.opf. +# epub_guide = () + +# HTML files that should be inserted before the pages created by sphinx. +# The format is a list of tuples containing the path and title. +# epub_pre_files = [] + +# HTML files shat should be inserted after the pages created by sphinx. +# The format is a list of tuples containing the path and title. +# epub_post_files = [] + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] + +# The depth of the table of contents in toc.ncx. +# epub_tocdepth = 3 + +# Allow duplicate toc entries. +# epub_tocdup = True + +# Choose between 'default' and 'includehidden'. +# epub_tocscope = 'default' + +# Fix unsupported image types using the Pillow. +# epub_fix_images = False + +# Scale large images. +# epub_max_image_width = 0 + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# epub_show_urls = 'inline' + +# If false, no index is generated. +# epub_use_index = True diff --git a/docs/genapidocs b/docs/genapidocs new file mode 100755 index 00000000..9e98a609 --- /dev/null +++ b/docs/genapidocs @@ -0,0 +1,5 @@ +#! /bin/sh + +cd "`dirname $0`"/.. && +exec sphinx-apidoc --separate --module-first --suffix=rst --force \ + --output-dir=docs/api sqlobject