Skip to content

[Doc]: Install info takes up too much room on new front page #21246

Closed

Description

@anntzer

Documentation Link

https://matplotlib.org/devdocs/index.html

Problem

The install info at the top takes ~1/3 of the available vertical space on the front page (before scrolling, but taking into account the fact that the "real" version number will not have a git tag). While important, it is something that most users have to do only once, whereas they (hopefully) will consult the rest of the docs more than once; therefore, it could be made slightly less tall.

Suggested improvement

The current panels:
current
without scrolling (and with a "released" version), the page cuts on my screen just after "API reference".

A few options (just some quick hacks, certainly better styling is possible):
alt1
alt2
alt3
On my screen, without scrolling, the page cuts after the link to pyplot.figure with the first and last design, and after the link to pyplot.subplots_mosaic after the middle one. I think having these immediately visible is nice to have.

For reference, the rst sources (comment out the unused ones)
.. code-block:: bash

   # Using conda:
   conda install matplotlib
   # Or using pip:
   pip install matplotlib

.. csv-table::
   :widths: 1 3

   Using `conda <https://docs.continuum.io/anaconda/>`__,``conda install matplotlib``
   Using `pip <https://pypi.org/project/matplotlib>`__,``pip install matplotlib``

.. csv-table::
   :widths: 1 2 1 2

   Using `conda <https://docs.continuum.io/anaconda/>`__:,``conda install matplotlib``,Using `pip <https://pypi.org/project/matplotlib>`__:,``pip install matplotlib``

Matplotlib Version

master

Matplotlib documentation version

(local build)

Activity

  1. jklymak commented on Oct 1, 2021

    @jklymak
    Member

    I'd vote for your second one (side-by-side)

  2. timhoffm commented on Oct 1, 2021

    @timhoffm
    Member

    Side by side is better. Is it possible to have the code in the table as code-block highlighting like before? I think it's valuable to have the commands stand out a bit more than just another font and color.

  3. anntzer commented on Oct 1, 2021

    @anntzer
    ContributorAuthor

    I gave it a quick try with .. raw:: html to set up the table and then interspersing .. code-blocks:: at the strategic place, but the vertical align is messed up. Probably just needs some more CSS hacking...

  4. timhoffm commented on Oct 7, 2021

    @timhoffm
    Member

    See #21313 for a solution. - That can be reused for the front page.

  5. added a commit that references this issue on Oct 24, 2021
    8e87309
  6. added this to the v3.5.0 milestone on Oct 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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