Sphinx extension which modifies the pep role to use normal (i.e. not bold) text for custom titles.
Also adds the pep621 role for referencing sections within PEP 621,
and the core-meta role for referencing sections in Python’s core metadata`.
Classes:
Functions:
-
class
CoreMetadata[source]
Bases: ReferenceRole
Sphinx role for referencing a core metadata field.
Methods:
build_uri()
|
Construct the target URI for the reference node. |
run()
|
Process the role. |
-
build_uri()[source]
Construct the target URI for the reference node.
- Return type
str
-
run()[source]
Process the role.
- Return type
Tuple[List[Node], List[system_message]]
-
class
PEP[source]
Bases: ReferenceRole
Sphinx role for referencing a PEP or a section thereof.
Methods:
build_uri()
|
Constrict the target URI for the reference node. |
run()
|
Process the role. |
-
build_uri()[source]
Constrict the target URI for the reference node.
- Return type
str
-
run()[source]
Process the role.
- Return type
Tuple[List[Node], List[system_message]]
-
class
PEP621Section[source]
Bases: PEP
Sphinx role for referencing a section within PEP 621.
Methods:
__call__(name, rawtext, text, lineno, inliner)
|
Call self as a function. |
-
__call__(name, rawtext, text, lineno, inliner, options={}, content=[])[source]
Call self as a function.
- Return type
Tuple[List[Node], List[system_message]]
-
setup(app)[source]
Setup sphinx_packaging.peps.
- Parameters
app (Sphinx) – The Sphinx application.
- Return type
Dict[str, Any]