| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| """Support for marking up implementation details.""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| from typing import TYPE_CHECKING | ||
|
|
||
| from docutils import nodes | ||
| from sphinx.locale import _ as sphinx_gettext | ||
| from sphinx.util.docutils import SphinxDirective | ||
|
|
||
| if TYPE_CHECKING: | ||
|
Comment thread
AA-Turner marked this conversation as resolved.
|
||
| from sphinx.application import Sphinx | ||
| from sphinx.util.typing import ExtensionMetadata | ||
|
|
||
|
|
||
| class ImplementationDetail(SphinxDirective): | ||
| has_content = True | ||
| final_argument_whitespace = True | ||
|
|
||
| # This text is copied to templates/dummy.html | ||
| label_text = sphinx_gettext("CPython implementation detail:") | ||
|
|
||
| def run(self): | ||
| self.assert_has_content() | ||
| content_nodes = self.parse_content_to_nodes() | ||
|
|
||
| # insert our prefix at the start of the first paragraph | ||
| first_node = content_nodes[0] | ||
| first_node[:0] = [ | ||
| nodes.strong(self.label_text, self.label_text), | ||
| nodes.Text(" "), | ||
| ] | ||
|
|
||
| # create a new compound container node | ||
| cnode = nodes.compound("", *content_nodes, classes=["impl-detail"]) | ||
| self.set_source_info(cnode) | ||
| return [cnode] | ||
|
|
||
|
|
||
| def setup(app: Sphinx) -> ExtensionMetadata: | ||
| app.add_directive("impl-detail", ImplementationDetail) | ||
|
|
||
| return { | ||
| "version": "1.0", | ||
| "parallel_read_safe": True, | ||
| "parallel_write_safe": True, | ||
| } | ||
| Back | FazBrowse Home | New Git URL |
Uh oh!
There was an error while loading. Please reload this page.