django-postgres-denormalize 1.0.0__tar.gz

django_postgres_denormalize-1.0.0/CHANGELOG.rst

@@ -0,0 +1,9 @@
+v1.0.0 (2026-10-18)
+-------------------
+Added:
+ * ``postgres_denormalize.fields.DenormalizedForeignKey``, a foreign key that stores a copy of the foreign key at the
+   end of a lookup path.
+ * ``postgres_denormalize.fields.DenormalizedField``, a column that stores a copy of any other column at the end of a
+   lookup path.
+ * Backfill tools as a migration operation (``postgres_denormalize.operations.BackfillDenormalized``) and a function
+   (``postgres_denormalize.operations.backfill_denormalized``).

django_postgres_denormalize-1.0.0/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2026, DjanQuiltDB Project
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright notice, this
+      list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name of the copyright holder nor the names of its
+      contributors may be used to endorse or promote products derived from
+      this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

django_postgres_denormalize-1.0.0/MANIFEST.in

@@ -0,0 +1,20 @@
+# The sdist is what downstream packagers build and test from, so it carries the whole test project and the docs, not
+# just the importable package. Without this, setuptools' defaults ship tests/test_*.py but none of the fixture apps or
+# settings they import, and the suite in the sdist cannot run.
+
+include CHANGELOG.rst
+include LICENSE
+include README.rst
+
+recursive-include src/postgres_denormalize py.typed
+
+graft docs
+graft tests
+
+# docs/conf.py points html_logo and html_favicon at ../assets, so a docs build from the sdist fails without these -- and
+# .readthedocs.yaml sets fail_on_warning, which turns a missing logo into a build failure rather than a shrug.
+graft assets
+
+prune docs/_build
+global-exclude *.py[cod]
+global-exclude __pycache__

django_postgres_denormalize-1.0.0/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: django-postgres-denormalize
+Version: 1.0.0
+Summary: Trigger-maintained copies of ancestor columns for Django on PostgreSQL.
+Author-email: DjanQuiltDB Project <djanquiltdb@portal42.net>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://github.com/djanquiltdb/django-postgres-denormalize
+Project-URL: Documentation, https://django-postgres-denormalize.readthedocs.io/
+Project-URL: Source, https://github.com/djanquiltdb/django-postgres-denormalize
+Project-URL: Issues, https://github.com/djanquiltdb/django-postgres-denormalize/issues
+Project-URL: Changelog, https://github.com/djanquiltdb/django-postgres-denormalize/blob/master/CHANGELOG.rst
+Keywords: django,database,postgresql,denormalization,triggers
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 6.0
+Classifier: Framework :: Django :: 6.1
+Classifier: Topic :: Database
+Classifier: Typing :: Typed
+Requires-Python: >=3.14
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: django<7.0,>=6.0
+Requires-Dist: django-pgtrigger<5,>=4.17
+Provides-Extra: lint
+Requires-Dist: ruff==0.15.21; extra == "lint"
+Provides-Extra: test
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: psycopg[binary]>=3.0.0; extra == "test"
+Requires-Dist: dj-database-url; extra == "test"
+Provides-Extra: docs
+Requires-Dist: sphinx<10,>=8; extra == "docs"
+Requires-Dist: sphinx-rtd-theme<4,>=3.1; extra == "docs"
+Requires-Dist: psycopg[binary]>=3.0.0; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: django-postgres-denormalize[docs,lint,test]; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: tox>=4.21; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+.. image:: https://raw.githubusercontent.com/DjanQuiltDB/django-postgres-denormalize/master/assets/icon-128.png
+    :alt: django-postgres-denormalize
+    :width: 128
+
+===========================
+django-postgres-denormalize
+===========================
+
+.. image:: https://img.shields.io/pypi/v/django-postgres-denormalize.svg
+    :target: https://pypi.org/project/django-postgres-denormalize/
+    :alt: PyPI
+
+.. image:: https://img.shields.io/pypi/pyversions/django-postgres-denormalize.svg
+    :target: https://pypi.org/project/django-postgres-denormalize/
+    :alt: Supported Python versions
+
+.. image:: https://img.shields.io/pypi/frameworkversions/django/django-postgres-denormalize.svg
+    :target: https://pypi.org/project/django-postgres-denormalize/
+    :alt: Supported Django versions
+
+.. image:: https://img.shields.io/badge/postgres-17%20%7C%2018-4169e1?logo=postgresql&logoColor=white
+    :target: https://www.postgresql.org/
+    :alt: Supported PostgreSQL versions
+
+.. image:: https://github.com/djanquiltdb/django-postgres-denormalize/actions/workflows/ci.yml/badge.svg
+    :target: https://github.com/djanquiltdb/django-postgres-denormalize/actions/workflows/ci.yml
+    :alt: CI
+
+.. image:: https://readthedocs.org/projects/django-postgres-denormalize/badge/?version=latest
+    :target: https://django-postgres-denormalize.readthedocs.io/
+    :alt: Documentation
+
+.. image:: https://img.shields.io/pypi/l/django-postgres-denormalize.svg
+    :target: https://github.com/djanquiltdb/django-postgres-denormalize/blob/master/LICENSE
+    :alt: BSD-3-Clause licence
+
+PostgreSQL cannot index, sort or constrain on a value that is stored in another table. A value that is several joins
+away, such as the tenant that a row belongs to through its parent, cannot be part of an index or a unique constraint on
+the row's table, and every query that filters or orders by it pays for the joins.
+
+This package lets a model store a copy of such a value in an ordinary column, and keeps the copy correct with
+PostgreSQL triggers. That works for every write, whether it comes from the ORM, a bulk update, raw SQL or the previous
+release that is still serving during a rolling deploy. The model declares the lookup path and nothing else;
+``makemigrations`` writes the column, the triggers and their changes.
+
+Full documentation is at https://django-postgres-denormalize.readthedocs.io/.
+
+.. code-block:: python
+
+    from django.db import models
+    from postgres_denormalize.fields import DenormalizedField, DenormalizedForeignKey
+
+
+    class Task(models.Model):
+        project = models.ForeignKey('Project', on_delete=models.CASCADE)
+        title = models.CharField(max_length=100)
+        # A copy of project.tenant: a real foreign key, its target and on_delete rule inferred from the path.
+        tenant = DenormalizedForeignKey('project__tenant')
+        # A copy of project.name: a column of the same type as the source.
+        project_name = DenormalizedField('project__name')
+
+        class Meta:
+            ordering = ['project_name', 'title']
+            constraints = [models.UniqueConstraint(fields=['tenant', 'title'], name='unique_task_title_per_tenant')]
+            indexes = [models.Index(fields=['tenant', 'project_name', 'title'], name='task_listing')]
+
+From then on, saving a task computes its copies in the database and reads them back onto the instance. Moving a
+project to another tenant, or renaming it, rewrites the copies of its tasks in the same transaction, but only the
+copies that change.
+
+**Use it for** values that an index or a unique constraint needs, and values that most queries sort or filter by across
+several joins. **Do not use it** to save a join for rendering, because ``select_related`` does that for free. Do not use
+it either for values whose source is often updated in bulk by code that you cannot wrap in one of its batch helpers.
+See `when to use it, and when not to
+<https://django-postgres-denormalize.readthedocs.io/en/latest/getting_started/when_to_use.html>`_, and the
+`alternatives <https://django-postgres-denormalize.readthedocs.io/en/latest/getting_started/alternatives.html>`_ page,
+which compares it with django-pgconstraints and django-computedfields.
+
+Installation
+------------
+
+.. code-block:: bash
+
+    pip install django-postgres-denormalize
+
+.. code-block:: python
+
+    INSTALLED_APPS = [
+        # ...
+        'pgtrigger',
+        'postgres_denormalize',
+    ]
+
+Requires PostgreSQL and django-pgtrigger, with pgtrigger's migration support turned on (the default). See the
+`settings reference <https://django-postgres-denormalize.readthedocs.io/en/latest/reference/settings.html>`_ for the
+options.
+
+Relationship to DjanQuiltDB
+---------------------------
+
+While this library was written in conjunction with `DjanQuiltDB <https://github.com/djanquiltdb/djanquiltdb>`_ and the
+libraries were designed to work together seamlessly in projects where both are installed, both libraries are written to
+be used as standalone libraries as well. For using django-postgres-denormalize, it is not necessary to use or be
+familiar with DjanQuiltDB.
+
+If you wish to use DjanQuiltDB features for the copies that django-postgres-denormalize keeps, you can install the
+``djanquiltdb[postgres-denormalize]`` extra. For more information, please refer to the DjanQuiltDB documentation.

django_postgres_denormalize-1.0.0/README.rst

@@ -0,0 +1,107 @@
+.. image:: https://raw.githubusercontent.com/DjanQuiltDB/django-postgres-denormalize/master/assets/icon-128.png
+    :alt: django-postgres-denormalize
+    :width: 128
+
+===========================
+django-postgres-denormalize
+===========================
+
+.. image:: https://img.shields.io/pypi/v/django-postgres-denormalize.svg
+    :target: https://pypi.org/project/django-postgres-denormalize/
+    :alt: PyPI
+
+.. image:: https://img.shields.io/pypi/pyversions/django-postgres-denormalize.svg
+    :target: https://pypi.org/project/django-postgres-denormalize/
+    :alt: Supported Python versions
+
+.. image:: https://img.shields.io/pypi/frameworkversions/django/django-postgres-denormalize.svg
+    :target: https://pypi.org/project/django-postgres-denormalize/
+    :alt: Supported Django versions
+
+.. image:: https://img.shields.io/badge/postgres-17%20%7C%2018-4169e1?logo=postgresql&logoColor=white
+    :target: https://www.postgresql.org/
+    :alt: Supported PostgreSQL versions
+
+.. image:: https://github.com/djanquiltdb/django-postgres-denormalize/actions/workflows/ci.yml/badge.svg
+    :target: https://github.com/djanquiltdb/django-postgres-denormalize/actions/workflows/ci.yml
+    :alt: CI
+
+.. image:: https://readthedocs.org/projects/django-postgres-denormalize/badge/?version=latest
+    :target: https://django-postgres-denormalize.readthedocs.io/
+    :alt: Documentation
+
+.. image:: https://img.shields.io/pypi/l/django-postgres-denormalize.svg
+    :target: https://github.com/djanquiltdb/django-postgres-denormalize/blob/master/LICENSE
+    :alt: BSD-3-Clause licence
+
+PostgreSQL cannot index, sort or constrain on a value that is stored in another table. A value that is several joins
+away, such as the tenant that a row belongs to through its parent, cannot be part of an index or a unique constraint on
+the row's table, and every query that filters or orders by it pays for the joins.
+
+This package lets a model store a copy of such a value in an ordinary column, and keeps the copy correct with
+PostgreSQL triggers. That works for every write, whether it comes from the ORM, a bulk update, raw SQL or the previous
+release that is still serving during a rolling deploy. The model declares the lookup path and nothing else;
+``makemigrations`` writes the column, the triggers and their changes.
+
+Full documentation is at https://django-postgres-denormalize.readthedocs.io/.
+
+.. code-block:: python
+
+    from django.db import models
+    from postgres_denormalize.fields import DenormalizedField, DenormalizedForeignKey
+
+
+    class Task(models.Model):
+        project = models.ForeignKey('Project', on_delete=models.CASCADE)
+        title = models.CharField(max_length=100)
+        # A copy of project.tenant: a real foreign key, its target and on_delete rule inferred from the path.
+        tenant = DenormalizedForeignKey('project__tenant')
+        # A copy of project.name: a column of the same type as the source.
+        project_name = DenormalizedField('project__name')
+
+        class Meta:
+            ordering = ['project_name', 'title']
+            constraints = [models.UniqueConstraint(fields=['tenant', 'title'], name='unique_task_title_per_tenant')]
+            indexes = [models.Index(fields=['tenant', 'project_name', 'title'], name='task_listing')]
+
+From then on, saving a task computes its copies in the database and reads them back onto the instance. Moving a
+project to another tenant, or renaming it, rewrites the copies of its tasks in the same transaction, but only the
+copies that change.
+
+**Use it for** values that an index or a unique constraint needs, and values that most queries sort or filter by across
+several joins. **Do not use it** to save a join for rendering, because ``select_related`` does that for free. Do not use
+it either for values whose source is often updated in bulk by code that you cannot wrap in one of its batch helpers.
+See `when to use it, and when not to
+<https://django-postgres-denormalize.readthedocs.io/en/latest/getting_started/when_to_use.html>`_, and the
+`alternatives <https://django-postgres-denormalize.readthedocs.io/en/latest/getting_started/alternatives.html>`_ page,
+which compares it with django-pgconstraints and django-computedfields.
+
+Installation
+------------
+
+.. code-block:: bash
+
+    pip install django-postgres-denormalize
+
+.. code-block:: python
+
+    INSTALLED_APPS = [
+        # ...
+        'pgtrigger',
+        'postgres_denormalize',
+    ]
+
+Requires PostgreSQL and django-pgtrigger, with pgtrigger's migration support turned on (the default). See the
+`settings reference <https://django-postgres-denormalize.readthedocs.io/en/latest/reference/settings.html>`_ for the
+options.
+
+Relationship to DjanQuiltDB
+---------------------------
+
+While this library was written in conjunction with `DjanQuiltDB <https://github.com/djanquiltdb/djanquiltdb>`_ and the
+libraries were designed to work together seamlessly in projects where both are installed, both libraries are written to
+be used as standalone libraries as well. For using django-postgres-denormalize, it is not necessary to use or be
+familiar with DjanQuiltDB.
+
+If you wish to use DjanQuiltDB features for the copies that django-postgres-denormalize keeps, you can install the
+``djanquiltdb[postgres-denormalize]`` extra. For more information, please refer to the DjanQuiltDB documentation.

django_postgres_denormalize-1.0.0/assets/icon-small.svg

@@ -0,0 +1,16 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64">
+  <path d="M15,42V36H49V42" fill="none" stroke="#31936D" stroke-width="5"
+        stroke-linecap="round" stroke-linejoin="round"/>
+
+  <rect x="16" y="3" width="32" height="19" rx="5" fill="#44B78B"/>
+  <rect x="23" y="10" width="18" height="5" rx="2.5" fill="#FFC757"/>
+
+  <rect x="1" y="42" width="29" height="19" rx="5" fill="#31936D"/>
+  <rect x="7" y="49" width="17" height="5" rx="2.5" fill="#FFC757"/>
+
+  <rect x="34" y="42" width="29" height="19" rx="5" fill="#1E6F50"/>
+  <rect x="40" y="49" width="17" height="5" rx="2.5" fill="#FFC757"/>
+
+  <path d="M37,21L25,37H32L28,47L41,31H34L37,21Z" fill="#FFC757"
+        stroke="#FFC757" stroke-width="2" stroke-linejoin="round"/>
+</svg>

django_postgres_denormalize-1.0.0/assets/icon.svg

@@ -0,0 +1,16 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64">
+  <path d="M16,43V37Q16,34 19,34H45Q48,34 48,37V43" fill="none" stroke="#31936D" stroke-width="3.5"
+        stroke-linecap="round" stroke-linejoin="round"/>
+
+  <rect x="19" y="5" width="26" height="17" rx="4.5" fill="#44B78B"/>
+  <rect x="25.5" y="11.6" width="13" height="3.8" rx="1.9" fill="#FFC757"/>
+
+  <rect x="3" y="43" width="26" height="16" rx="4.5" fill="#31936D"/>
+  <rect x="9.5" y="49.1" width="13" height="3.8" rx="1.9" fill="#FFC757"/>
+
+  <rect x="35" y="43" width="26" height="16" rx="4.5" fill="#1E6F50"/>
+  <rect x="41.5" y="49.1" width="13" height="3.8" rx="1.9" fill="#FFC757"/>
+
+  <path d="M35.5,22.5L27,34.5H32.5L29.5,42.5L38.5,30.5H33L35.5,22.5Z" fill="#FFC757"
+        stroke="#FFC757" stroke-width="1.2" stroke-linejoin="round"/>
+</svg>

django_postgres_denormalize-1.0.0/assets/social-preview.svg

@@ -0,0 +1,21 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1280 640" width="1280" height="640">
+  <rect width="1280" height="640" fill="#092e20"/>
+  <g transform="translate(98 192) scale(4)">
+    <path d="M16,43V37Q16,34 19,34H45Q48,34 48,37V43" fill="none" stroke="#31936D" stroke-width="3.5"
+          stroke-linecap="round" stroke-linejoin="round"/>
+    <rect x="19" y="5" width="26" height="17" rx="4.5" fill="#44B78B"/>
+    <rect x="25.5" y="11.6" width="13" height="3.8" rx="1.9" fill="#FFC757"/>
+    <rect x="3" y="43" width="26" height="16" rx="4.5" fill="#31936D"/>
+    <rect x="9.5" y="49.1" width="13" height="3.8" rx="1.9" fill="#FFC757"/>
+    <rect x="35" y="43" width="26" height="16" rx="4.5" fill="#1E6F50"/>
+    <rect x="41.5" y="49.1" width="13" height="3.8" rx="1.9" fill="#FFC757"/>
+    <path d="M35.5,22.5L27,34.5H32.5L29.5,42.5L38.5,30.5H33L35.5,22.5Z" fill="#FFC757"
+          stroke="#FFC757" stroke-width="1.2" stroke-linejoin="round"/>
+  </g>
+
+  <g font-family="Noto Sans, DejaVu Sans, Liberation Sans, sans-serif">
+    <text id="title" x="420" y="296" font-size="53" font-weight="700" fill="#ffffff">django-postgres-denormalize</text>
+    <rect x="423" y="328" width="170" height="5" fill="#FFC757"/>
+    <text id="tagline" x="420" y="385" font-size="31" font-weight="400" fill="#44B78B">Trigger-maintained copies of ancestor columns</text>
+  </g>
+</svg>

django_postgres_denormalize-1.0.0/docs/Makefile

@@ -0,0 +1,14 @@
+# Minimal makefile for Sphinx documentation
+
+SPHINXOPTS    ?= -W
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

django_postgres_denormalize-1.0.0/docs/_static/custom.css

@@ -0,0 +1,96 @@
+:root {
+    --dpd-ink: #092e20;
+    --dpd-gold: #FFC757;
+    --dpd-mint: #E3F4EE;
+    --dpd-mint-soft: #EFF9F5;
+    --dpd-mint-deep: #CBEBDF;
+    --dpd-mint-line: #ABDFCB;
+}
+
+.wy-side-nav-search > a.wordmark {
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    gap: 0.6em;
+    padding: 0;
+}
+
+.wy-side-nav-search > a.wordmark img.logo {
+    flex: none;
+    width: 72px;
+    height: 72px;
+    margin: 0;
+}
+
+.wy-side-nav-search > a.wordmark .name {
+    position: relative;
+    padding-bottom: 4px;
+    color: #ffffff;
+    font-size: 1.3em;
+    font-weight: 700;
+    line-height: 1.05;
+    text-align: left;
+}
+
+.wy-side-nav-search > a.wordmark .name::after {
+    content: "";
+    position: absolute;
+    bottom: 0;
+    left: 0;
+    width: 23%;
+    height: 2px;
+    background: var(--dpd-gold);
+}
+
+.wy-nav-side {
+    background: var(--dpd-mint);
+    color: var(--dpd-ink);
+}
+
+.wy-menu-vertical a {
+    color: var(--dpd-ink);
+}
+
+.wy-menu-vertical a:hover {
+    background-color: var(--dpd-mint-deep);
+    color: var(--dpd-ink);
+}
+
+.wy-menu-vertical header,
+.wy-menu-vertical p.caption {
+    color: #1E6F50;
+}
+
+.wy-menu-vertical li.current {
+    background: var(--dpd-mint-soft);
+}
+
+.wy-menu-vertical li.current a {
+    border-right: 1px solid var(--dpd-mint-line);
+    color: var(--dpd-ink);
+}
+
+.wy-menu-vertical li.current a:hover {
+    background: var(--dpd-mint-deep);
+}
+
+.wy-menu-vertical li.current > a,
+.wy-menu-vertical li.on a {
+    background: #ffffff;
+    color: var(--dpd-ink);
+}
+
+.wy-menu-vertical li.current > a:hover,
+.wy-menu-vertical li.on a:hover {
+    background: #ffffff;
+}
+
+.wy-menu-vertical li.toctree-l1.current > a {
+    border-top: 1px solid var(--dpd-mint-line);
+    border-bottom: 1px solid var(--dpd-mint-line);
+}
+
+.wy-menu-vertical li.toctree-l2.current > a,
+.wy-menu-vertical li.toctree-l2.current li.toctree-l3 > a {
+    background: var(--dpd-mint-deep);
+}

django_postgres_denormalize-1.0.0/docs/_templates/layout.html

@@ -0,0 +1,30 @@
+{% extends "!layout.html" %}
+
+{%- block sidebartitle %}
+
+  {%- set _logo_url = logo_url|default(pathto('_static/' + (logo or ""), 1)) %}
+  {%- set _root_doc = root_doc|default(master_doc) %}
+  <a href="{{ pathto(_root_doc) }}" class="wordmark">
+    {%- if logo or logo_url %}
+      <img src="{{ _logo_url }}" class="logo" alt="{{ _('Logo') }}"/>
+    {%- endif %}
+    <span class="name">django-<br/>postgres-<br/>denormalize</span>
+  </a>
+
+  {%- if READTHEDOCS or DEBUG %}
+    {%- if theme_version_selector or theme_language_selector %}
+      <div class="switch-menus">
+        <div class="version-switch"></div>
+        <div class="language-switch"></div>
+      </div>
+    {%- endif %}
+  {%- endif %}
+
+  {%- include "searchbox.html" %}
+
+{%- endblock %}
+
+{%- block mobile_nav %}
+  <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+  <a href="{{ pathto(master_doc) }}">django-postgres-denormalize</a>
+{%- endblock %}

django_postgres_denormalize-1.0.0/docs/conf.py

@@ -0,0 +1,96 @@
+#!/usr/bin/env python3
+#
+# django-postgres-denormalize documentation build configuration file.
+
+import datetime
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../src/'))
+
+from django.conf import settings  # noqa: E402
+
+from postgres_denormalize import __version__  # noqa: E402
+
+settings.configure()
+
+
+# -- General configuration ------------------------------------------------
+
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.githubpages', 'sphinx_rtd_theme']
+
+source_suffix = '.rst'
+
+master_doc = 'index'
+
+project = 'django-postgres-denormalize'
+copyright = '{} DjanQuiltDB Project'.format(datetime.date.today().year)  # noqa: A001
+author = 'DjanQuiltDB Project'
+
+release = version = __version__
+
+language = 'en'
+
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+pygments_style = 'sphinx'
+
+todo_include_todos = False
+
+# Members are documented in source order, which follows the order a reader meets them in.
+autodoc_member_order = 'bysource'
+
+
+# -- Options for HTML output ----------------------------------------------
+
+html_theme = 'sphinx_rtd_theme'
+
+# The header the sidebar and the narrow-screen bar share, in the dark green the social preview card uses.
+html_theme_options = {'style_nav_header_background': '#092e20'}
+
+# docs/_templates/layout.html restyles that header; without this it is not picked up at all.
+templates_path = ['_templates']
+
+html_static_path = ['_static']
+
+# The favicon is a raster rather than the logo itself: below about 32 pixels the lightning bolt blurs into the branch
+# beneath it, so those sizes are rendered from assets/icon-small.svg, which is drawn for them.
+html_logo = '../assets/icon.svg'
+html_favicon = '../assets/icon-32.png'
+
+# Only to style the sidebar header the template above replaces; see the file itself.
+html_css_files = ['custom.css']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+htmlhelp_basename = project
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {}
+
+latex_documents = [
+    (master_doc, 'django-postgres-denormalize.tex', '{} Documentation'.format(project), author, 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+man_pages = [(master_doc, project, '{} Documentation'.format(project), [author], 1)]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+texinfo_documents = [
+    (
+        master_doc,
+        project,
+        '{} Documentation'.format(project),
+        author,
+        project,
+        'Trigger-maintained copies of ancestor columns for Django on PostgreSQL.',
+        'Miscellaneous',
+    ),
+]