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
Make the left sidebar in the doc collapsible #47393
Comments
I was just browsing the development docs, and noticed that the new For comparison, here are screen shots from the old and new documentation: Is this side bar going to be present in the final release of the python |
I agree with this bug entry. Also, since pages are usually long, if the (of course this could also be considered bikeshedding :-)) |
+1 coat to the bikeshed, the new layout is painful unless you're at a |
+1 to support this bug entry. Even though I have wide-monitor (1680x1050), keeping such a wide left side margin is a pain when reading the new docs. I was looking for the settings if there is any way to turn off the left navigation or change the CSS style to a more plain one. Nope, it is not there. |
I know about this and will think about possible ways out of it. Of |
I assume this is relative to the resolution of a user's monitor. For me, |
It is relative to the resolution of the user's browser window. Don't |
Using "position: fixed" was requested in bpo-4965 too and I posted a proof It might also be possible to make the sidebar collapsible using |
I just did a quick test about making the sidebar collapsible. /* collapse the sidebar */ A "<<" / ">>" button has to be added (via JS) to collapse and restore The WebDeveloper plug-in of Firefox can be used to see the changes on |
Another screenshot that shows the page with and without the sidebar, |
Attached a first attempt to make the sidebar collapsible. If you want to try it just extract the files, open the *.html with a This is not supposed to be the final version, I tested it only on FF3 |
Here's a new version. Now it works with all the major browsers and it's I tested it on the following browsers, and I didn't notice any problem/bug: I also tested it on a Nokia 5800, where the sidebar normally takes more A few things could be improved:
|
This should be the final version, these are the things I improved:
I also tried to make it faster (with no appreciable results). I tested it on the aforementioned browsers and it seems to work fine, so |
I just noticed Ezio's change to the title of this bug. Does the proposed fix address the original bug title ("docs waste a lot of horizontal space on left nav bar") for third-party packages that use docutils to generate their docs? Or, does it only avoid the problem in the official python documentation? |
I'm pretty sure it only applies to the python docs, since this is the Python tracker, not the Sphinx or docutils tracker. (I'm not sure how the 'Documentation tools (Sphinx)' component gets in there...as far as I know Sphinx bugs go the Sphinx bug tracker.) |
Even if I tested it only with Python documentation, the script should work for other docs generated by Sphinx (at least with the default theme). |
Committed the sidebar.js to Sphinx trunk. When Python switches to 1.0, we can activate the option to use it. Thanks Ezio! |
Now used in trunk docs, r83274. |
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
bugs.python.org fields:
The text was updated successfully, but these errors were encountered: