You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
For functions, methods, and exceptions, we manually create h3 headers:
We do this so that:
it shows up in the page ToC, since that is computed based on headers
there's the little icon to make an anchor link
But we don't have to have a header for those two benefits; there are other ways we could get that. We can teach our page ToC to understand code objects, and we can add the little anchor icon to the code object directly.
Fixing this will remove duplication and get our design closer to qiskit-sphinx-theme, which we liked:
To implement this, we'll want MDX components like <Function>, which relates to the implementation for #735.
The trickiest part will be the page ToC. We need to make sure we consider the surrounding context like if the parent heading level.
The text was updated successfully, but these errors were encountered:
Eric-Arellano
changed the title
Remove manually created headers from API docs
Remove API docs headers for functions, exceptions, and methods
Mar 4, 2024
For functions, methods, and exceptions, we manually create h3 headers:
We do this so that:
But we don't have to have a header for those two benefits; there are other ways we could get that. We can teach our page ToC to understand code objects, and we can add the little anchor icon to the code object directly.
Fixing this will remove duplication and get our design closer to qiskit-sphinx-theme, which we liked:
To implement this, we'll want MDX components like
<Function>
, which relates to the implementation for #735.The trickiest part will be the page ToC. We need to make sure we consider the surrounding context like if the parent heading level.
The text was updated successfully, but these errors were encountered: