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

fix: Trim trailing dash in api docs #2112 #2145

Merged
merged 2 commits into from
Oct 2, 2023
Merged

fix: Trim trailing dash in api docs #2112 #2145

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
900a1be
fix: trim trailing dash in api docs #2112
marek-mihok Sep 26, 2023
8cb5fd0
chore: add explanation comment #2112
marek-mihok Oct 2, 2023
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
7 changes: 5 additions & 2 deletions py/docs/templates/text.mako
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,12 @@ ${docstring | to_html}
<div className='api'>

% if is_method:
${"####"} ${f.name} <a name="${f.refname}"/>
## Using <a> with name prop as an anchor adds additional dash to the URL - https://github.com/facebook/docusaurus/issues/8901.
## Using <span> with id instead.
${"####"} <span id="${f.refname}">${f.name}</span>

% else:
${"###"} ${f.name} <a name="${f.refname}"/>
${"###"} <span id="${f.refname}">${f.name}</span>
% endif

<%
Expand Down