Skip to content

Replace custom roles with styled extlinks #1351

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

Merged
merged 2 commits into from
Jul 16, 2024
Merged

Replace custom roles with styled extlinks #1351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
783a30a
Replace custom roles with styled extlinks
hugovk Jul 15, 2024
2a66c4c
Use code formatting
hugovk Jul 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .editorconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ indent_size = 4
[*.rst]
indent_size = 3

[*.yml]
[*.{css,yml}]
indent_size = 2
43 changes: 0 additions & 43 deletions _extensions/custom_roles.py
View file
Open in desktop

This file was deleted.

11 changes: 10 additions & 1 deletion _static/devguide_overrides.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@

.release-cycle-chart .release-cycle-blob {
stroke-width: 1.6px;
/* default colours, overriden below for individual statuses */
/* default colours, overridden below for individual statuses */
fill: var(--color-background-primary);
stroke: var(--color-foreground-primary);
}
Expand Down Expand Up @@ -85,3 +85,12 @@
.bad pre {
border-left: 3px solid rgb(244, 76, 78);
}

.extlink-cpy-file,
.extlink-gh-label {
border: 1px solid var(--color-background-border);
border-radius: .2em;
font-family: var(--font-stack--monospace);
font-size: var(--font-size--small--2);
padding: .1em .2em;
}
9 changes: 3 additions & 6 deletions conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
import os
import sys
import time

# Location of custom extensions.
sys.path.insert(0, os.path.abspath(".") + "/_extensions")

extensions = [
'custom_roles',
'notfound.extension',
'sphinx.ext.extlinks',
'sphinx.ext.intersphinx',
Expand Down Expand Up @@ -176,7 +170,10 @@
# This config is a dictionary of external sites,
# mapping unique short aliases to a base URL and a prefix.
# https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html
_repo = "https://github.com/python/cpython"
extlinks = {
"cpy-file": (f"{_repo}/blob/main/%s", "%s"),
"gh-label": (f"{_repo}/labels/%s", "%s"),
"github": ("https://github.com/%s", "%s"),
"github-user": ("https://github.com/%s", "@%s"),
"pypi": ("https://pypi.org/project/%s/", "%s"),
Expand Down
2 changes: 1 addition & 1 deletion internals/parser.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -537,7 +537,7 @@ parser (the one used by the interpreter) just execute: ::

make regen-pegen

using the :cpy-file:`!Makefile` in the main directory. If you are on Windows you can
using the ``Makefile`` in the main directory. If you are on Windows you can
use the Visual Studio project files to regenerate the parser or to execute: ::

./PCbuild/build.bat --regen
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ sphinx-notfound-page>=1.0.0
sphinx_copybutton>=0.3.3
sphinxext-opengraph>=0.7.1
sphinxext-rediraffe
Sphinx~=7.3.7
Sphinx~=7.4.0
Loading