Skip to content

[docs] Integrate sphinx-issues into the Sphinx config #12551

@webknjaz

Description

@webknjaz

What's the problem this feature will solve?

Reducing maintenance burden in this repo.

Describe the solution you'd like

Integrate https://github.com/sloria/sphinx-issues, replacing most of the extlinks definitions in docs/html/conf.py.

Alternative Solutions

.. not doing this?

Additional context

Many projects copy-paste definitions like "issue": ("https://github.com/pypa/pip/issues/%s", "#%s"), but it basically means that alls those places where it's pasted need to be updated. Like the last time %s needed to be added everywhere due to update in Sphinx itself.
Moreover, said extension is implemented in a more flexible manner, provides an extended syntax and extra linking related roles (like referencing GH users) for free.

Code of Conduct

Metadata

Metadata

Assignees

Labels

good first issueA good item for first time contributors to work ontype: docsDocumentation relatedtype: feature requestRequest for a new featuretype: maintenanceRelated to Development and Maintenance Processes

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions