diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 0323d42c..ef0d20c3 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -77,3 +77,16 @@ jobs: env: SQLALCHEMY_UTILS_TEST_POSTGRESQL_PASSWORD: postgres run: tox -e ${{ matrix.tox_env }} + + docs: + runs-on: 'ubuntu-latest' + steps: + - uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: '3.12' + - name: Install tox + run: pip install tox + - name: Build documentation + run: tox -e docs diff --git a/.gitignore b/.gitignore index 478217e2..c467fc84 100644 --- a/.gitignore +++ b/.gitignore @@ -61,3 +61,5 @@ venv/ ENV/ env.bak/ venv.bak/ + +poetry.lock diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..ed29cbd8 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,14 @@ +version: 2 + +build: + os: "ubuntu-22.04" + tools: + python: "3.12" + +python: + install: + - requirements: "requirements/docs/requirements.txt" + +sphinx: + configuration: "docs/conf.py" + fail_on_warning: false diff --git a/CHANGES.rst b/CHANGES.rst index 59455a2c..ab2eb19d 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -8,6 +8,9 @@ Unreleased changes - Drop support for Python 3.7 and 3.8. - Add support for Python 3.12. +- Add a Read the Docs configuration file. +- Make documentation builds reproducible. +- Test documentation builds in CI. 0.41.2 (2024-03-22) ^^^^^^^^^^^^^^^^^^^ diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index 047bde59..00000000 --- a/docs/Makefile +++ /dev/null @@ -1,153 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = _build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -# 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 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 " 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 " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - -rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -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/SQLAlchemy-Utils.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SQLAlchemy-Utils.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/SQLAlchemy-Utils" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SQLAlchemy-Utils" - @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." - -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." diff --git a/docs/conf.py b/docs/conf.py index db411fc7..ef559461 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,246 +1,37 @@ -# SQLAlchemy-Utils documentation build configuration file, created by -# sphinx-quickstart on Tue Feb 19 11:16:09 2013. -# -# 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 os -import sys - -# 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('..')) -from sqlalchemy_utils import __version__ +import importlib.metadata # -- 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.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode'] +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.doctest", + "sphinx.ext.intersphinx", + "sphinx.ext.todo", + "sphinx.ext.coverage", + "sphinx.ext.ifconfig", + "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' +templates_path = ["_templates"] # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = 'SQLAlchemy-Utils' -copyright = '2013-2022, Konsta Vesterinen' +project = "SQLAlchemy-Utils" +copyright = "2013-2022, Konsta Vesterinen" -# 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 = __version__ -# The full version, including alpha/beta/rc tags. +version = importlib.metadata.version("sqlalchemy_utils") release = version -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# 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 +exclude_patterns = ["_build"] # 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 = [] - - -# -- 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'] - -# 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 - -# Output file base name for HTML help builder. -htmlhelp_basename = 'SQLAlchemy-Utilsdoc' - - -# -- 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': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'SQLAlchemy-Utils.tex', 'SQLAlchemy-Utils Documentation', - 'Konsta Vesterinen', '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', 'sqlalchemy-utils', 'SQLAlchemy-Utils Documentation', - ['Konsta Vesterinen'], 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', 'SQLAlchemy-Utils', 'SQLAlchemy-Utils Documentation', - 'Konsta Vesterinen', 'SQLAlchemy-Utils', 'One line description of project.', - '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' - +# pygments_style = "sphinx" -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/3/': None} +html_theme = "sphinx_rtd_theme" diff --git a/docs/data_types.rst b/docs/data_types.rst index 0000df88..4e81c05e 100644 --- a/docs/data_types.rst +++ b/docs/data_types.rst @@ -74,12 +74,11 @@ EmailType EncryptedType ------------- -.. module:: sqlalchemy_utils.types.encrypted.encrypted_type - .. deprecated:: 0.36.6 Use StringEncryptedType instead -.. autoclass:: EncryptedType +.. autoclass:: sqlalchemy_utils.types.encrypted.encrypted_type.EncryptedType + JSONType -------- diff --git a/docs/database_helpers.rst b/docs/database_helpers.rst index 75d276af..7dffa18a 100644 --- a/docs/database_helpers.rst +++ b/docs/database_helpers.rst @@ -2,52 +2,49 @@ Database helpers ================ -.. module:: sqlalchemy_utils.functions - - database_exists --------------- -.. autofunction:: database_exists +.. autofunction:: sqlalchemy_utils.functions.database_exists create_database --------------- -.. autofunction:: create_database +.. autofunction:: sqlalchemy_utils.functions.create_database drop_database ------------- -.. autofunction:: drop_database +.. autofunction:: sqlalchemy_utils.functions.drop_database has_index --------- -.. autofunction:: has_index +.. autofunction:: sqlalchemy_utils.functions.has_index has_unique_index ---------------- -.. autofunction:: has_unique_index +.. autofunction:: sqlalchemy_utils.functions.has_unique_index json_sql -------- -.. autofunction:: json_sql +.. autofunction:: sqlalchemy_utils.functions.json_sql render_expression ----------------- -.. autofunction:: render_expression +.. autofunction:: sqlalchemy_utils.functions.render_expression render_statement ---------------- -.. autofunction:: render_statement +.. autofunction:: sqlalchemy_utils.functions.render_statement diff --git a/docs/foreign_key_helpers.rst b/docs/foreign_key_helpers.rst index 0d309a43..47edd80c 100644 --- a/docs/foreign_key_helpers.rst +++ b/docs/foreign_key_helpers.rst @@ -1,40 +1,32 @@ Foreign key helpers =================== -.. module:: sqlalchemy_utils.functions - dependent_objects ----------------- -.. autofunction:: dependent_objects +.. autofunction:: sqlalchemy_utils.functions.dependent_objects get_referencing_foreign_keys ---------------------------- -.. autofunction:: get_referencing_foreign_keys +.. autofunction:: sqlalchemy_utils.functions.get_referencing_foreign_keys group_foreign_keys ------------------ -.. autofunction:: group_foreign_keys - - -is_indexed_foreign_key ----------------------- - -.. autofunction:: is_indexed_foreign_key +.. autofunction:: sqlalchemy_utils.functions.group_foreign_keys merge_references ---------------- -.. autofunction:: merge_references +.. autofunction:: sqlalchemy_utils.functions.merge_references non_indexed_foreign_keys ------------------------ -.. autofunction:: non_indexed_foreign_keys +.. autofunction:: sqlalchemy_utils.functions.non_indexed_foreign_keys diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 0298f86a..00000000 --- a/docs/make.bat +++ /dev/null @@ -1,190 +0,0 @@ -@ECHO OFF - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set BUILDDIR=_build -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . -set I18NSPHINXOPTS=%SPHINXOPTS% . -if NOT "%PAPER%" == "" ( - set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% - set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% -) - -if "%1" == "" goto help - -if "%1" == "help" ( - :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. text to make text files - echo. man to make manual pages - echo. texinfo to make Texinfo files - echo. gettext to make PO message catalogs - echo. changes to make an overview over all changed/added/deprecated items - echo. linkcheck to check all external links for integrity - echo. doctest to run all doctests embedded in the documentation if enabled - goto end -) - -if "%1" == "clean" ( - for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i - del /q /s %BUILDDIR%\* - goto end -) - -if "%1" == "html" ( - %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/html. - goto end -) - -if "%1" == "dirhtml" ( - %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. - goto end -) - -if "%1" == "singlehtml" ( - %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. - goto end -) - -if "%1" == "pickle" ( - %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the pickle files. - goto end -) - -if "%1" == "json" ( - %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the JSON files. - goto end -) - -if "%1" == "htmlhelp" ( - %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run HTML Help Workshop with the ^ -.hhp project file in %BUILDDIR%/htmlhelp. - goto end -) - -if "%1" == "qthelp" ( - %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run "qcollectiongenerator" with the ^ -.qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\SQLAlchemy-Utils.qhcp - echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\SQLAlchemy-Utils.ghc - goto end -) - -if "%1" == "devhelp" ( - %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. - goto end -) - -if "%1" == "epub" ( - %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The epub file is in %BUILDDIR%/epub. - goto end -) - -if "%1" == "latex" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "text" ( - %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The text files are in %BUILDDIR%/text. - goto end -) - -if "%1" == "man" ( - %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The manual pages are in %BUILDDIR%/man. - goto end -) - -if "%1" == "texinfo" ( - %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. - goto end -) - -if "%1" == "gettext" ( - %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The message catalogs are in %BUILDDIR%/locale. - goto end -) - -if "%1" == "changes" ( - %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes - if errorlevel 1 exit /b 1 - echo. - echo.The overview file is in %BUILDDIR%/changes. - goto end -) - -if "%1" == "linkcheck" ( - %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck - if errorlevel 1 exit /b 1 - echo. - echo.Link check complete; look for any errors in the above output ^ -or in %BUILDDIR%/linkcheck/output.txt. - goto end -) - -if "%1" == "doctest" ( - %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest - if errorlevel 1 exit /b 1 - echo. - echo.Testing of doctests in the sources finished, look at the ^ -results in %BUILDDIR%/doctest/output.txt. - goto end -) - -:end diff --git a/docs/models.rst b/docs/models.rst index b1131630..e87ef91f 100644 --- a/docs/models.rst +++ b/docs/models.rst @@ -5,14 +5,10 @@ Model mixins Timestamp --------- -.. module:: sqlalchemy_utils.models - -.. autoclass:: Timestamp +.. autoclass:: sqlalchemy_utils.models.Timestamp generic_repr ------------ -.. module:: sqlalchemy_utils.models - -.. autofunction:: generic_repr +.. autofunction:: sqlalchemy_utils.models.generic_repr diff --git a/docs/orm_helpers.rst b/docs/orm_helpers.rst index aeb7b2a0..92fd4ae3 100644 --- a/docs/orm_helpers.rst +++ b/docs/orm_helpers.rst @@ -1,124 +1,110 @@ ORM helpers =========== -.. module:: sqlalchemy_utils.functions - cast_if ------- -.. autofunction:: cast_if +.. autofunction:: sqlalchemy_utils.functions.cast_if escape_like ----------- -.. autofunction:: escape_like +.. autofunction:: sqlalchemy_utils.functions.escape_like get_bind -------- -.. autofunction:: get_bind +.. autofunction:: sqlalchemy_utils.functions.get_bind get_class_by_table ------------------ -.. autofunction:: get_class_by_table +.. autofunction:: sqlalchemy_utils.functions.get_class_by_table get_column_key -------------- -.. autofunction:: get_column_key +.. autofunction:: sqlalchemy_utils.functions.get_column_key get_columns ----------- -.. autofunction:: get_columns +.. autofunction:: sqlalchemy_utils.functions.get_columns get_declarative_base -------------------- -.. autofunction:: get_declarative_base +.. autofunction:: sqlalchemy_utils.functions.get_declarative_base get_hybrid_properties --------------------- -.. autofunction:: get_hybrid_properties +.. autofunction:: sqlalchemy_utils.functions.get_hybrid_properties get_mapper ---------- -.. autofunction:: get_mapper - - -get_query_entities ------------------- - -.. autofunction:: get_query_entities +.. autofunction:: sqlalchemy_utils.functions.get_mapper get_primary_keys ---------------- -.. autofunction:: get_primary_keys +.. autofunction:: sqlalchemy_utils.functions.get_primary_keys get_tables ---------- -.. autofunction:: get_tables +.. autofunction:: sqlalchemy_utils.functions.get_tables get_type -------- -.. autofunction:: get_type +.. autofunction:: sqlalchemy_utils.functions.get_type has_changes ----------- -.. autofunction:: has_changes +.. autofunction:: sqlalchemy_utils.functions.has_changes identity -------- -.. autofunction:: identity +.. autofunction:: sqlalchemy_utils.functions.identity is_loaded --------- -.. autofunction:: is_loaded +.. autofunction:: sqlalchemy_utils.functions.is_loaded make_order_by_deterministic --------------------------- -.. autofunction:: make_order_by_deterministic +.. autofunction:: sqlalchemy_utils.functions.make_order_by_deterministic naturally_equivalent -------------------- -.. autofunction:: naturally_equivalent +.. autofunction:: sqlalchemy_utils.functions.naturally_equivalent quote ----- -.. autofunction:: quote - - -sort_query ----------- - -.. autofunction:: sort_query +.. autofunction:: sqlalchemy_utils.functions.quote diff --git a/docs/range_data_types.rst b/docs/range_data_types.rst index e57abe19..05d77eba 100644 --- a/docs/range_data_types.rst +++ b/docs/range_data_types.rst @@ -4,8 +4,6 @@ Range data types .. automodule:: sqlalchemy_utils.types.range - - DateRangeType ------------- diff --git a/docs/view.rst b/docs/view.rst index 029f3359..1ae67752 100644 --- a/docs/view.rst +++ b/docs/view.rst @@ -1,22 +1,20 @@ View utilities ============== -.. module:: sqlalchemy_utils - create_view ----------- -.. autofunction:: create_view +.. autofunction:: sqlalchemy_utils.view.create_view create_materialized_view ------------------------ -.. autofunction:: create_materialized_view +.. autofunction:: sqlalchemy_utils.view.create_materialized_view refresh_materialized_view ------------------------- -.. autofunction:: refresh_materialized_view +.. autofunction:: sqlalchemy_utils.view.refresh_materialized_view diff --git a/requirements/README.rst b/requirements/README.rst new file mode 100644 index 00000000..0a0de758 --- /dev/null +++ b/requirements/README.rst @@ -0,0 +1,45 @@ +``requirements/`` +################# + +This directory contains the files that manage dependencies for the project. + +Each subdirectory in this directory contains a ``pyproject.toml`` file +with purpose-specific dependencies listed. + + +How it's used +============= + +Tox is configured to use the exported ``requirements.txt`` files as needed. +In addition, Read the Docs is configured to use ``docs/requirements.txt``. +This helps ensure reproducible testing, linting, and documentation builds. + + +How it's updated +================ + +A tox label, ``update``, ensures that dependencies can be easily updated, +and that ``requirements.txt`` files are consistently re-exported. + +This can be invoked by running: + +.. code-block:: + + tox run -m update + + +How to add dependencies +======================= + +New dependencies can be added to a given subdirectory's ``pyproject.toml`` +by either manually modifying the file, or by running a command like: + +.. code-block:: + + poetry add --lock --directory "requirements/$DIR" $DEPENDENCY_NAME + +Either way, the dependencies must be re-exported: + +.. code-block:: + + tox run -m update diff --git a/requirements/docs/poetry.toml b/requirements/docs/poetry.toml new file mode 100644 index 00000000..1d8dfee7 --- /dev/null +++ b/requirements/docs/poetry.toml @@ -0,0 +1,2 @@ +[warnings] +export = false diff --git a/requirements/docs/pyproject.toml b/requirements/docs/pyproject.toml new file mode 100644 index 00000000..1df8cb6a --- /dev/null +++ b/requirements/docs/pyproject.toml @@ -0,0 +1,7 @@ +[tool.poetry] +package-mode = false + +[tool.poetry.dependencies] +python = ">=3.9" +sphinx = "*" +sphinx-rtd-theme = "*" diff --git a/requirements/docs/requirements.txt b/requirements/docs/requirements.txt new file mode 100644 index 00000000..3f8cd502 --- /dev/null +++ b/requirements/docs/requirements.txt @@ -0,0 +1,27 @@ +alabaster==0.7.16 ; python_version >= "3.9" +babel==2.16.0 ; python_version >= "3.9" +certifi==2024.8.30 ; python_version >= "3.9" +charset-normalizer==3.3.2 ; python_version >= "3.9" +colorama==0.4.6 ; python_version >= "3.9" and sys_platform == "win32" +docutils==0.20.1 ; python_version >= "3.9" +idna==3.8 ; python_version >= "3.9" +imagesize==1.4.1 ; python_version >= "3.9" +importlib-metadata==8.4.0 ; python_version < "3.10" and python_version >= "3.9" +jinja2==3.1.4 ; python_version >= "3.9" +markupsafe==2.1.5 ; python_version >= "3.9" +packaging==24.1 ; python_version >= "3.9" +pygments==2.18.0 ; python_version >= "3.9" +requests==2.32.3 ; python_version >= "3.9" +snowballstemmer==2.2.0 ; python_version >= "3.9" +sphinx-rtd-theme==2.0.0 ; python_version >= "3.9" +sphinx==7.4.7 ; python_version >= "3.9" +sphinxcontrib-applehelp==2.0.0 ; python_version >= "3.9" +sphinxcontrib-devhelp==2.0.0 ; python_version >= "3.9" +sphinxcontrib-htmlhelp==2.1.0 ; python_version >= "3.9" +sphinxcontrib-jquery==4.1 ; python_version >= "3.9" +sphinxcontrib-jsmath==1.0.1 ; python_version >= "3.9" +sphinxcontrib-qthelp==2.0.0 ; python_version >= "3.9" +sphinxcontrib-serializinghtml==2.0.0 ; python_version >= "3.9" +tomli==2.0.1 ; python_version < "3.11" and python_version >= "3.9" +urllib3==2.2.2 ; python_version >= "3.9" +zipp==3.20.1 ; python_version < "3.10" and python_version >= "3.9" diff --git a/sqlalchemy_utils/functions/database.py b/sqlalchemy_utils/functions/database.py index 8e12ce72..9af39d2e 100644 --- a/sqlalchemy_utils/functions/database.py +++ b/sqlalchemy_utils/functions/database.py @@ -602,8 +602,10 @@ def drop_database(url): :param url: A SQLAlchemy engine URL. - Works similar to the :ref:`create_database` method in that both url text - and a constructed url are accepted. :: + Works similar to the :func:`create_database` method in that both url text + and a constructed url are accepted. + + :: drop_database('postgresql://postgres@localhost/name') drop_database(engine.url) diff --git a/sqlalchemy_utils/generic.py b/sqlalchemy_utils/generic.py index 1e2dd17e..a9ec5f3c 100644 --- a/sqlalchemy_utils/generic.py +++ b/sqlalchemy_utils/generic.py @@ -106,9 +106,9 @@ class GenericRelationshipProperty(MapperProperty): """A generic form of the relationship property. Creates a 1 to many relationship between the parent model - and any other models using a descriminator (the table name). + and any other models using a discriminator (the table name). - :param discriminator + :param discriminator: Field to discriminate which model we are referring to. :param id: Field to point to the model we are referring to. diff --git a/sqlalchemy_utils/observer.py b/sqlalchemy_utils/observer.py index 6d007297..7a4acc3a 100644 --- a/sqlalchemy_utils/observer.py +++ b/sqlalchemy_utils/observer.py @@ -150,7 +150,7 @@ class Product(Base): Observing multiple columns ------------------------ +-------------------------- You can also observe multiple columns by specifying all the observable columns in the decorator. @@ -360,9 +360,9 @@ class Category(Base): .. versionadded: 0.28.0 - :param *paths: One or more dot-notated property paths, eg. + :param paths: One or more dot-notated property paths, eg. 'categories.products.price' - :param **observer: A dictionary where value for key 'observer' contains + :param observer_kw: A dictionary where value for key 'observer' contains :meth:`PropertyObserver` object """ observer_ = observer_kw.pop('observer', observer) diff --git a/sqlalchemy_utils/types/country.py b/sqlalchemy_utils/types/country.py index 3895db68..888b2294 100644 --- a/sqlalchemy_utils/types/country.py +++ b/sqlalchemy_utils/types/country.py @@ -7,7 +7,7 @@ class CountryType(ScalarCoercible, types.TypeDecorator): """ Changes :class:`.Country` objects to a string representation on the way in - and changes them back to :class:`.Country objects on the way out. + and changes them back to :class:`.Country` objects on the way out. In order to use CountryType you need to install Babel_ first. diff --git a/sqlalchemy_utils/types/range.py b/sqlalchemy_utils/types/range.py index 0d682b5a..42a641e3 100644 --- a/sqlalchemy_utils/types/range.py +++ b/sqlalchemy_utils/types/range.py @@ -197,20 +197,22 @@ def notin_(self, other): def __rshift__(self, other, **kwargs): """ - Returns whether or not given interval is strictly right of another - interval. + Returns whether or not given interval is strictly right of another interval. - [a, b] >> [c, d] True, if a > d + .. code-block:: + + [a, b] >> [c, d] True, if a > d """ other = self.coerce_arg(other) return self.op('>>')(other) def __lshift__(self, other, **kwargs): """ - Returns whether or not given interval is strictly left of another - interval. + Returns whether or not given interval is strictly left of another interval. + + .. code-block:: - [a, b] << [c, d] True, if b < c + [a, b] << [c, d] True, if b < c """ other = self.coerce_arg(other) return self.op('<<')(other) diff --git a/tox.ini b/tox.ini index b72ac941..c293cef0 100644 --- a/tox.ini +++ b/tox.ini @@ -3,6 +3,9 @@ envlist = py{3.9, 3.10, 3.11, 3.12}-sqlalchemy{13, 14, 2} flake8 isort + docs +labels = + update = update-{requirements, pre-commit} [testenv] commands = @@ -43,6 +46,12 @@ recreate = False deps = pre-commit commands = pre-commit run --hook-stage manual --all isort-check +[testenv:docs] +base_python = py3.12 +recreate = False +deps = -r requirements/docs/requirements.txt +commands = sphinx-build docs/ build/docs + [pytest] filterwarnings = error @@ -55,3 +64,24 @@ filterwarnings = ignore:'crypt' is deprecated and slated for removal:DeprecationWarning ; Ignore Python 3.12 UTC deprecation warnings caused by pendulum. ignore:datetime.datetime.utcfromtimestamp:DeprecationWarning + + +[testenv:update-{requirements, pre-commit}] +base_python = py3.12 +recreate = true +description = Update tool dependency versions +skip_install = true +deps = + requirements: poetry + requirements: poetry-plugin-export + pre-commit: pre-commit +commands = + # Update requirements files + requirements: poetry update --directory="requirements/docs" --lock + requirements: poetry export --directory="requirements/docs" --output="requirements/docs/requirements.txt" --without-hashes + + # Update pre-commit hook versions + pre-commit: pre-commit autoupdate + + # Run pre-commit immediately, but ignore its exit code + pre-commit: - pre-commit run -a