Skip to content

Commit

Permalink
docs: drop the jaraco.packaging.sphinx documentation dependency
Browse files Browse the repository at this point in the history
We're seeing tracebacks when using specific sphinx versions. We don't
really need this dependency for the docs.
  • Loading branch information
davvid committed Apr 11, 2024
1 parent cb9077b commit 016291f
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 9 deletions.
1 change: 1 addition & 0 deletions CHANGES.rst
Expand Up @@ -6,6 +6,7 @@ v3.0.4
* A `garden.yaml` file was added for use with the
`garden <https://crates.io/crates/garden-tools>_` command runner. (+486)
* The test suite was updated to avoid deprecated SQLALchemy APIs.
* The `jaraco.packaging.sphinx` documentation dependency was removed.

v3.0.3
======
Expand Down
13 changes: 5 additions & 8 deletions docs/conf.py
Expand Up @@ -5,10 +5,6 @@
import furo
except ImportError:
furo = None
try:
import jaraco.packaging.sphinx as jaraco_packaging_sphinx
except ImportError:
jaraco_packaging_sphinx = None
try:
import rst.linker as rst_linker
except ImportError:
Expand All @@ -23,9 +19,8 @@
'sphinx.ext.todo',
'sphinx.ext.coverage',
]
if jaraco_packaging_sphinx is not None:
extensions += ['jaraco.packaging.sphinx']

project = 'jsonpickle'
master_doc = 'index'

if furo is not None:
Expand All @@ -34,17 +29,19 @@
# Link dates and other references in the changelog
if rst_linker is not None:
extensions += ['rst.linker']

package_url = 'https://github.com/jsonpickle/jsonpickle'
link_files = {
'../CHANGES.rst': dict(
using=dict(GH='https://github.com'),
replace=[
dict(
pattern=r'(Issue #|\B#)(?P<issue>\d+)',
url='{package_url}/issues/{issue}',
url=package_url + '/issues/{issue}',
),
dict(
pattern=r'\B\+(?P<pull>\d+)',
url='{package_url}/pull/{pull}',
url=package_url + '/pull/{pull}',
),
dict(
pattern=r'(?m:^((?P<scm_version>v?\d+(\.\d+){1,2}))\n[-=]+\n)',
Expand Down
1 change: 0 additions & 1 deletion setup.cfg
Expand Up @@ -65,7 +65,6 @@ testing =
docs =
# upstream
sphinx
jaraco.packaging >= 9
rst.linker >= 1.9
furo

Expand Down

0 comments on commit 016291f

Please sign in to comment.