Skip to content

DOC: new index page - #20737

Merged
story645 merged 1 commit into
matplotlib:masterfrom
jklymak:doc-new-doc-index
Jul 25, 2021
Merged

story645 merged 1 commit into
matplotlib:masterfrom
jklymak:doc-new-doc-index

Conversation

@jklymak

@jklymak jklymak commented Jul 24, 2021 •

Copy link
Copy Markdown
Member

PR Summary

Start on a landing page.

Closes #20735

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

@jklymak jklymak changed the title DOC: new index page [skip actions] [skip azp] [skip appveyor] DOC: new index page Jul 24, 2021
@jklymak
jklymak force-pushed the doc-new-doc-index branch from 99c907c to 38d5466 Compare July 24, 2021 17:01
@jklymak

jklymak commented Jul 25, 2021

Copy link
Copy Markdown
Member Author

This is very bare-bones, but probably good for a start. I actually think it would be nice to add a cool image somewhere (probably the bottom), and the different sections could be put into boxes or something. But I'm not really sure about how fancy this has to be or whether the brochure page will point here, or just a level down.

@jklymak
jklymak marked this pull request as ready for review July 25, 2021 03:20
@story645

Copy link
Copy Markdown
Member

As much as I like the divio guide, I think I agree w/ you that learn vs understand doesn't make sense to someone not familiar w/ the framework & we probably need to contextualize, something like

  • Learn how to use the library
  • Understand how the library works

Comment thread doc/index.rst Resolved
Comment thread doc/index.rst Resolved
Comment thread doc/index.rst Resolved
@jklymak jklymak added this to the v3.5.0 milestone Jul 25, 2021

@timhoffm timhoffm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good start. I'm ok to merge as is (after CI pass).

@jklymak
jklymak force-pushed the doc-new-doc-index branch from 1175a11 to ca8c260 Compare July 25, 2021 15:48
@jklymak
jklymak force-pushed the doc-new-doc-index branch from ca8c260 to 4d974bf Compare July 25, 2021 16:42
Comment thread doc/index.rst
.. _jdh-fellowship: https://numfocus.org/programs/john-hunter-technology-fellowship/
.. _nf: https://numfocus.org
How-tos
=======

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to link the gallery here - the gallery has many examples of how to make plots, or are we differentiating that into learn how to do things with the library?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The gallery is already linked above under "Learn", so I was thinking it didn't need to be re-linked. I was also thinking that these "How Tos" could be more specific, and perhaps higher level than making plots. i.e. How to do things that help you make plots, but not "How do I make a line plot?"

@story645
story645 merged commit 0f767cf into matplotlib:master Jul 25, 2021
@jklymak
jklymak deleted the doc-new-doc-index branch July 26, 2021 00:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The top level of the docs needs modification

3 participants