Actions
Feature #21018
openAdd CSS to pdoc to improve admonition rendering
Story points:
0.5
Description
We use admonitions for deprecation notices in the Python SDK. The HTML comes out like this:
<aside class="admonition warning">
<strong>WARNING</strong>
<em>Deprecated</em>
<p><a href="#clear_tmpdir">clear_tmpdir</a> is deprecated and scheduled to be removed in Arvados 3.0.</p>
</aside>
None of this has any styling, so it's pretty plain and a little difficult to follow. Add CSS to do the following:
- Give the whole
aside
block a yellow background to distinguish it from other documentation. - Add content with punctuation to better separate the
strong
and theem
. - Add
aside.admonition em { font-weight: normal; }
- Consider
aside.admonition strong { text-transform: uppercase; }
See this pdoc FAQ and the few that follow for instructions on how to do this. Customizing the pdoc invocation can be done by extending doc/pysdk_pdoc.py
.
Related issues
Updated by Brett Smith about 1 year ago
- Follows Idea #20885: Revise Python docstring style for Markdown extensions added
- Start date set to 08/17/2023
- Due date set to 08/17/2023
Updated by Peter Amstutz 8 months ago
- Target version changed from To be scheduled to Future
Actions