Bullet list style for single parameter functions in RTD theme using autodoc and Sphinx?

Viewed 287

I've noticed that when I use autodoc with the ReadTheDoc theme, if I have multiple arguments in my functions they are listed in a bullet list style:

  • arg1
  • arg2
  • ...

but if there is only 1 argument then it is not using the bullet list style which is a bit silly to me since it breaks the continuity of the design.

I've found how to remove the disc via CSS to make things more uniform but I actually want to do the opposite and have the disk for the single argument functions. At this point, I'm not sure it is a CSS change and I do not know how to do that.

I've also noticed the same thing in different docs.

Here is the rendered html: enter image description here

Here are the 2 methods:


def add_attribute(self, name, index):
    """
    :param name: The name attached to the attribute.
    :param index: The position of the attribute within the list of attributes. """
    print("")

def delete_attribute(self, name):
    """
    :param name: The name of the attribute to delete."""
    print("")

Here is the my .rst:

API
----------------

.. automodule:: my_module
   :members:

Here is the conf.py

extensions = [
    'sphinx_rtd_theme',
    'sphinx.ext.autodoc',
    'sphinx.ext.napoleon',
    'sphinx.ext.coverage',
    'sphinx.ext.autosummary',
]

templates_path = ['_templates']

language = 'python'

exclude_patterns = []

html_theme = "sphinx_rtd_theme"

html_static_path = ['_static']

autosummary_generate = True

Any idea? Cheers!

0 Answers
Related