updates docs

Author: saxix

CHANGES

@@ -1,9 +1,9 @@
-Release 2.x (dev)
--------------
+Release 2.3
+-----------
 * Removes code producing DeprecationError
-* add `AUTO_CREATE_TRIGGERS`  and deprecate `MANUAL_TRIGGERS`
+* add :setting:`AUTO_CREATE_TRIGGERS`  and deprecate :setting:`MANUAL_TRIGGERS`
 * add support for Postgres 13
-
+* add ability to customise SQL to create triggers :setting:`TRIGGERS_FACTORY`
 
 Release 2.2
 -------------

Makefile

@@ -11,7 +11,7 @@ DJANGO?='last'
 develop:
 	@pip install pipenv
 	@sh -c "if [ '${DBENGINE}' = 'mysql' ]; then pip install  MySQL-python; fi"
-	@sh -c "if [ '${DBENGINE}' = 'pg' ]; then pip install -q psycopg2; fi"
+	@sh -c "if [ '${DBENGINE}' = 'pg' ]; then pip install -q psycopg2-binary; fi"
 	$(MAKE) .init-db
 	@pipenv install -d --skip-lock
 
@@ -48,7 +48,7 @@ fullclean:
 
 docs: .mkbuilddir
 	mkdir -p ${BUILDDIR}/docs
-	pipenv run sphinx-build -aE docs/ ${BUILDDIR}/docs
+	sphinx-build -aE docs/ ${BUILDDIR}/docs
 ifdef BROWSE
 	firefox ${BUILDDIR}/docs/index.html
 endif

Pipfile

@@ -20,6 +20,7 @@ tox = "*"
 "psycopg2-binary" = "*"
 check-manifest = "*"
 sphinx = "*"
+sphinx-issues = "*"
 twine="*"
 
 [requires]

docs/_ext/github.py

@@ -5,6 +5,7 @@
 from sphinx.util.console import bold
 # RE for option descriptions without a '--' prefix
 from sphinx.writers.html import HTMLTranslator
+from sphinx.errors import ExtensionError
 
 simple_option_desc_re = re.compile(
     r'([-_a-zA-Z0-9]+)(\s*.*?)(?=,\s+(?:/|-|--)|$)')
@@ -32,99 +33,8 @@ def setup(app):
         indextemplate="pair: %s; field lookup type",
     )
     app.add_config_value('next_version', '0.0', True)
-    app.add_directive('versionadded', VersionDirective)
-    app.add_directive('versionchanged', VersionDirective)
     app.add_crossref_type(
         directivename="release",
         rolename="release",
         indextemplate="pair: %s; release",
     )
-
-class DjangoHTMLTranslator(HTMLTranslator):
-    """
-    Django-specific reST to HTML tweaks.
-    """
-
-    # Don't use border=1, which docutils does by default.
-    def visit_table(self, node):
-        self.context.append(self.compact_p)
-        self.compact_p = True
-        self._table_row_index = 0  # Needed by Sphinx
-        self.body.append(self.starttag(node, 'table', CLASS='docutils'))
-
-    def depart_table(self, node):
-        self.compact_p = self.context.pop()
-        self.body.append('</table>\n')
-
-    def visit_desc_parameterlist(self, node):
-        self.body.append('(')  # by default sphinx puts <big> around the "("
-        self.first_param = 1
-        self.optional_param_level = 0
-        self.param_separator = node.child_text_separator
-        self.required_params_left = sum([isinstance(c, addnodes.desc_parameter)
-                                         for c in node.children])
-
-    def depart_desc_parameterlist(self, node):
-        self.body.append(')')
-
-
-    version_text = {
-        'deprecated': 'Deprecated in Django-Concurrency %s',
-        'versionchanged': 'Changed in Django-Concurrency %s',
-        'versionadded': 'New in Django-Concurrency %s',
-    }
-
-    def visit_versionmodified(self, node):
-        self.body.append(
-            self.starttag(node, 'div', CLASS=node['type'])
-        )
-        version_text = self.version_text.get(node['type'])
-        if version_text:
-            title = "%s%s" % (
-                version_text % node['version'],
-                ":" if len(node) else "."
-            )
-            self.body.append('<span class="title">%s</span> ' % title)
-
-    def depart_versionmodified(self, node):
-        self.body.append("</div>\n")
-
-    # Give each section a unique ID -- nice for custom CSS hooks
-    def visit_section(self, node):
-        old_ids = node.get('ids', [])
-        node['ids'] = ['s-' + i for i in old_ids]
-        node['ids'].extend(old_ids)
-        HTMLTranslator.visit_section(self, node)
-        node['ids'] = old_ids
-
-
-
-class VersionDirective(Directive):
-    has_content = True
-    required_arguments = 1
-    optional_arguments = 1
-    final_argument_whitespace = True
-    option_spec = {}
-
-    def run(self):
-        if len(self.arguments) > 1:
-            msg = """Only one argument accepted for directive '{directive_name}::'.
-            Comments should be provided as content,
-            not as an extra argument.""".format(directive_name=self.name)
-            raise self.error(msg)
-
-        env = self.state.document.settings.env
-        ret = []
-        node = addnodes.versionmodified()
-        ret.append(node)
-
-        if self.arguments[0] == env.config.next_version:
-            node['version'] = "Development version"
-        else:
-            node['version'] = self.arguments[0]
-
-        node['type'] = self.name
-        if self.content:
-            self.state.nested_parse(self.content, self.content_offset, node)
-        env.note_versionchange(node['type'], node['version'], node, self.lineno)
-        return ret

docs/_ext/version.py

@@ -75,7 +75,7 @@ ConcurrentModelAdmin
 --------------------
 .. autoclass:: concurrency.admin.ConcurrentModelAdmin
 
-.. warning:: If you customize ``fields`` or ``fieldsets`` remember to add version field to the list. (See issue :ghissue:`81`)
+.. warning:: If you customize ``fields`` or ``fieldsets`` remember to add version field to the list. (See issue :issue:`81`)
 
 
 
@@ -252,6 +252,22 @@ Templatetags
 .. autofunction:: concurrency.templatetags.concurrency.is_version
 
 
+--------
+Triggers
+--------
+
+.. _triggerfactory:
+
+TriggerFactory
+--------------
+
+.. versionadded:: 2.3
+
+.. autoclass:: concurrency.triggers.TriggerFactory
+
+.. seealso:: :setting:`TRIGGERS_FACTORY`
+
+
 
 -------------
 Test Utilties

docs/api.rst

@@ -37,8 +37,9 @@
               'sphinx.ext.autosummary',
               'sphinx.ext.coverage',
               'sphinx.ext.viewcode',
-              'version',
-              'github']
+              'sphinx_issues',
+              'version'
+              ]
 
 intersphinx_mapping = {
     'python': ('https://docs.python.org/2.7/', None),

docs/conf.py

@@ -1,2 +1,2 @@
-sphinx
-django
+sphinx==3.5.2
+django==3.1