Feature #21018
Updated by Brett Smith 8 months ago
We use "admonitions":https://github.com/trentm/python-markdown2/wiki/admonitions for deprecation notices in the Python SDK. The HTML comes out like this:
<pre><code class="html">
<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>
</code></pre>
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 the @em@.
* Add @aside.admonition em { font-weight: normal; }@
* Consider @aside.admonition strong { text-transform: uppercase; }@
See "this pdoc FAQ":https://pdoc.dev/docs/pdoc.html#edit-pdocs-html-template 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@.