Skip to content

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

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

Closed
jorisvandenbossche opened this issue Jul 8, 2013 · 7 comments
Labels
Milestone

Comments

@jorisvandenbossche
Copy link
Member

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.
@jreback
Copy link
Contributor

jreback commented Jul 8, 2013

is there a way to have a determined at runtime eg what the browser reports as the width. (maybe with a maximum)?

@jorisvandenbossche
Copy link
Member Author

I looked at the standard sphinx theme, and there they work with a mininum and maximum width (eg http://sphinx-doc.org/tutorial.html). For me, this seems like a better approach for now. I submit a PR.

@jorisvandenbossche
Copy link
Member Author

The doc width is discussed in the PR, but do you have an idea about the indentation of the bulleted list?
Do I go ahead and submit a PR for adapting v0.12.0.txt, or is this not important enough to change the whole file?

@jreback
Copy link
Contributor

jreback commented Jul 10, 2013

merging this.....3.2.1

jreback added a commit that referenced this issue Jul 10, 2013
@jreback
Copy link
Contributor

jreback commented Jul 10, 2013

closed via #4165

@jreback jreback closed this as completed Jul 10, 2013
@ghost
Copy link

ghost commented Jul 11, 2013

@jorisvandenbossche thanks for bringing this up, the docs do look nicer now.

@jorisvandenbossche
Copy link
Member Author

@y-p Glad I can contribute a little bit (and I am preparing another one for the figures in the docs)

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

No branches or pull requests

2 participants