Skip to content

DOC: width of page (text area) too small and wrong indentation of bullet lists #4159

Closed
@jorisvandenbossche

Description

@jorisvandenbossche

I noticed that the width of the docs (the text area) is set to a certain maximum in the dev/0.12 version, which I think is a good idea! (certain for wide screens). However, I think it is a little bit too small, as illustrated with the figure below:

pandas-docs

You can see that I have to use the horizontal scrollbar to see the whole code snippet (while it is well within the 80 char limit).
This is partly due to the too small width of the text area, but also partly due to a wrong use of indentation in bulleted lists. Lists don't need any indentation, see http://sphinx-doc.org/rest.html. But almost everywhere (at least in the whatsnew of v0.12.0.txt) indentation is used, with the consequence that the lists in the html are over-indented as you can see in the picture.

Possible actions to take:

  • Increase the maximum width a little bit? I think code snippets should certainly be shown in full width without scrollbar.
    An example of code snippet (without being in a bulleted list) which needs a scrollbar (on my screen): http://pandas.pydata.org/pandas-docs/dev/whatsnew.html#dtypes
  • Remove the unnecessary indentation in lists, maybe to start with in the whatsnew v0.12.0.txt (and it can be discussed if it also has to be adapted in older files). If you think this is OK, I can submit a PR for this.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions