Merge pull request #766 from sphinx-contrib/maintenance-2023-03-04

maintenance 2023-03-04

Author: jdknight

CONTRIBUTING.rst

@@ -74,37 +74,18 @@ marked as end-of-life as well as support Sphinx versions with a suggested
 maximum of five major-minor trees.
 
 - Python interpreters that have not been marked as end-of-life will be supported
-  by this extension. An exception exists for Python 2.7 at this time where
-  support *may* extend to the RHEL's supported end-of-life date for Python 2.7
-  of June 2024 (see also `How is Python 2 supported in RHEL after 2020?`_). Note
-  that this is the maximum date for support; however, support may be dropped
-  earlier than this date (with a notification). At minimum, Python 2.7 will be
-  supported until the end of the 2020 calendar year (a year after Python's
-  end-of-life date for Python 2.7).
+  by this extension.
 - Supported Confluence versions will be supported versions listed in
   `Atlassian Support End of Life Policy`_.
 - Supported Sphinx versions include the last five major-minor versions of the
-  application (e.g. 3.2.x, 3.1.x, 3.0.x, 2.4.x, 2.3.x). An exception exists for
-  Sphinx 1.8.x series, which will be supported until this extension's support
-  for Python 2.7 has been dropped.
+  application (e.g. 3.2.x, 3.1.x, 3.0.x, 2.4.x, 2.3.x).
 
 `PEP 8`_ is a standard styling guide for Python projects and is recommended for
-considerations when making contributions. On that note, please read the
-following:
-
-- Line lengths are recommended to be at maximum 79 characters (relaxed to even
-  80 characters) for implementation. This option is not explicitly enforced in
-  styling checks primarily since there can be valid cases where lines may exceed
-  such limits (e.g. a long URL in comments).
-- The recommendation of two blank lines (in various scenarios) are ignored.
-  Apply appropriate blank lines where it makes sense in the implementation.
-- Avoid multiple imports on a single line (even for ``from ...`` usages). This
-  is to help long term maintenance of imports with minimal clashing between
-  various modules/types/etc. being used.
+consideration when making contributions. Default linters configured in tox are
+required to pass. Note that select exceptions may be used.
 
 .. _Atlassian Support End of Life Policy: https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html
 .. _Developer’s Certificate of Origin: https://developercertificate.org/
-.. _How is Python 2 supported in RHEL after 2020?: https://access.redhat.com/solutions/4455511
-.. _PEP 8: https://www.python.org/dev/peps/pep-0008
+.. _PEP 8: https://peps.python.org/pep-0008/
 .. _issue tracker: https://github.com/sphinx-contrib/confluencebuilder/issues
 .. _pull requests: https://github.com/sphinx-contrib/confluencebuilder/pulls

doc/features.rst

@@ -204,7 +204,7 @@ or create a new extension which can bind both desired extensions together
 added into this extension's repository will be limited to the arbitrary
 release/development windows of this extension.
 
-The following table show a most recent state of various third-party extensions
+The following table shows a most recent state of various third-party extensions
 interacting with this extension:
 
 .. only:: latex

doc/roles.rst

@@ -149,12 +149,13 @@ generated Confluence documents.
 
         :confluence_status:`WARNING <yellow>`
 
-    To tweak the style of a status macro to an outlined variant, adjust the
-    color enclosure to square brackets:
+    To tweak the style of a status macro to an outlined variant (if supported
+    by the configured Confluence editor), adjust the color enclosure to
+    square brackets:
 
     .. code-block:: rst
 
-        :confluence_status:`PASSED <green>`
+        :confluence_status:`PASSED [green]`
 
 
 .. references ------------------------------------------------------------------

sphinxcontrib/confluencebuilder/assets.py

@@ -94,7 +94,7 @@ def build(self):
         A tuple entry will contain the following:
 
          - The key (or name) of the asset.
-         - The absolulte path of the asset on the system.
+         - The absolute path of the asset on the system.
          - The content-type value of the asset.
          - The hash value of the asset.
          - The name of the document this asset should be published to.

tox.ini

@@ -8,9 +8,6 @@ envlist =
 [testenv]
 deps =
     -r{toxinidir}/requirements_dev.txt
-    sphinx44: sphinx>=4.4,<4.5
-    sphinx45: sphinx>=4.5,<4.6
-    sphinx50: sphinx>=5.0,<5.1
     sphinx51: sphinx>=5.1,<5.2
     sphinx52: sphinx>=5.2,<5.3
     sphinx53: sphinx>=5.3,<5.4
@@ -72,7 +69,7 @@ commands =
     {envpython} -m tests.test_sandbox {posargs}
 passenv = *
 
-[testenv:{,py37-,py38-,py39-,py310-,py311-}validation]
+[testenv:{,py37-,py38-,py39-,py310-,py311-,py312-}validation]
 deps = 
     {[testenv]deps}
     -r{toxinidir}/requirements_validation.txt