CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-06 03:08:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

Ignore d.py's |coro| substitution in Sphinx (#5648)

Browse Source
This commit is contained in:
jack1142 2022-03-31 15:12:31 +02:00 committed by GitHub
parent d8e20afa1d
commit 67e43eb00b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/conf.py
View File

@ -251,3 +251,21 @@ doctest_test_doctest_blocks = ""
# Autodoc options # Autodoc options
autodoc_default_options = {"show-inheritance": True} autodoc_default_options = {"show-inheritance": True}
autodoc_typehints = "none" autodoc_typehints = "none"
from docutils import nodes
from sphinx.transforms import SphinxTransform
# d.py's |coro| substitution leaks into our docs because we don't replace some of the docstrings
class IgnoreCoroSubstitution(SphinxTransform):
default_priority = 210
def apply(self, **kwargs) -> None:
for ref in self.document.traverse(nodes.substitution_reference):
if ref["refname"] == "coro":
ref.replace_self(nodes.Text("", ""))
def setup(app):
app.add_transform(IgnoreCoroSubstitution)