Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open
1 task done
webknjaz opened this issue Mar 1, 2024 · 3 comments · May be fixed by #12616
Open
1 task done

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

webknjaz opened this issue Mar 1, 2024 · 3 comments · May be fixed by #12616
Assignees
@shenxianpeng
Labels
good first issue A good item for first time contributors to work on type: docs Documentation related type: feature request Request for a new feature type: maintenance Related to Development and Maintenance Processes

Comments

@webknjaz
Copy link
Member

webknjaz commented Mar 1, 2024

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
@webknjaz webknjaz added type: docs Documentation related good first issue A good item for first time contributors to work on C: automation Automated checks, CI etc type: maintenance Related to Development and Maintenance Processes type: feature request Request for a new feature S: needs triage Issues/PRs that need to be triaged labels Mar 1, 2024
@Keyuan125
Copy link

Can I try to work on this issue?

@uranusjr
Copy link
Member

uranusjr commented Apr 1, 2024

Sure, give it a go.

@shenxianpeng shenxianpeng linked a pull request Apr 9, 2024 that will close this issue
Open
@shenxianpeng
Copy link
Contributor

Since I see this ticket hasn't started at all, so I draft PR #12616

@ichard26 ichard26 removed C: automation Automated checks, CI etc S: needs triage Issues/PRs that need to be triaged labels Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@shenxianpeng shenxianpeng

Labels
good first issue A good item for first time contributors to work on type: docs Documentation related type: feature request Request for a new feature type: maintenance Related to Development and Maintenance Processes
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[docs] Integrate sphinx-issues into the Sphinx config shenxianpeng/pip
5 participants
@webknjaz @uranusjr @shenxianpeng @Keyuan125 @ichard26