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.

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

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

Closed
patrys opened this issue Nov 5, 2013 · 2 comments
Closed

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

patrys opened this issue Nov 5, 2013 · 2 comments

Comments

@patrys
Copy link

patrys commented Nov 5, 2013

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

@tony
Copy link
Contributor

tony commented Nov 5, 2013

@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.

tony added a commit to tony/sphinx_rtd_theme that referenced this issue Nov 5, 2013
snide added a commit that referenced this issue Nov 5, 2013
Examples for issue #34 and #35 for dave tomorrow
@snide snide closed this as completed in aa05551 Nov 5, 2013
@snide
Copy link
Collaborator

snide commented Nov 5, 2013

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants