search

readthedocs / sphinx_rtd_theme

Sphinx theme from Read the Docs
https://sphinx-rtd-theme.readthedocs.io/
MIT License
4.79k stars 1.74k forks source link

Class and function syntax is near-impossible to read #35

Closed patrys closed 11 years ago

patrys commented 11 years ago

Example: http://django-payments.readthedocs.org/en/latest/modules.html

tony commented 11 years ago

@patrys Thank you for the report, I can see it.

@snide: In autodoc, optional arguments are encased with [ and ].

HTML output for them will show:

<dt id="payments.dotpay.DotpayProvider">
<em class="property">class </em><tt class="descclassname">payments.dotpay.</tt><tt class="descname">DotpayProvider</tt>

<big>(</big>

<em>seller_id</em>, <em>pin</em><span class="optional">[</span>, <em>channel=0</em>
<span class="optional">[</span>, <em>lock=False</em><span class="optional">]</span>, 
<em>lang='pl'</em><span class="optional">]</span>

<big>)</big>

<a class="headerlink" href="#payments.dotpay.DotpayProvider" title="Permalink to this definition">¶</a></dt>

There is opportunity to adjust padding in various locations here. I will follow up with PR for demo tests for functional arguments and leave the CSS adjustments to you.

snide commented 11 years ago

This is how it will look http://snid.es/image/2Y2Q2x072W0n

I notice that in Chrome/Windows I have some font issues that make it not as pretty, so I'm curious if that's what you're using. Otherwise, let me know if this works.