Skip to content

Dev docs update #15617

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
Jul 3, 2020
Merged

Dev docs update #15617

merged 6 commits into from
Jul 3, 2020

Conversation

pambot
Copy link
Contributor

@pambot pambot commented Nov 6, 2019

PR Summary

This closes #15610, which is about some missing information in the development installation docs.

  • link to devdocs, the main page can be confused for the latest master docs
  • git clean -xfd if you want to change configs and rebuild
  • pip install -e . for dev
  • make a dev.txt that is union of travis all flake8 36 (doc it too)
  • maybe update main readme

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@pambot pambot force-pushed the macosx-dev-docs-update branch from 32c9a41 to 262d6d4 Compare November 6, 2019 20:17
tacaswell
tacaswell reviewed Nov 6, 2019
View reviewed changes
tacaswell
tacaswell reviewed Nov 6, 2019
View reviewed changes
tacaswell
tacaswell reviewed Nov 6, 2019
View reviewed changes
tacaswell
tacaswell reviewed Nov 6, 2019
View reviewed changes
tacaswell
tacaswell reviewed Nov 6, 2019
View reviewed changes
tacaswell
tacaswell reviewed Nov 6, 2019
View reviewed changes
tacaswell
tacaswell reviewed Nov 6, 2019
View reviewed changes
@pambot pambot force-pushed the macosx-dev-docs-update branch 2 times, most recently from e8d6f55 to 91fcbef Compare November 6, 2019 21:14
@pambot
Copy link
Contributor Author

pambot commented Nov 6, 2019 •
edited
Loading

@tacaswell Thanks for the comments! I addressed them all.

@pambot
Copy link
Contributor Author

pambot commented Nov 11, 2019

@tacaswell Could you please take another look? I'm up for more edits if it needs it.

timhoffm
timhoffm reviewed Nov 17, 2019
View reviewed changes
@tacaswell
Copy link
Member

@pambot Hope you don't mind I took the liberty of resolving some of the discussions by pushing commits!

anntzer
anntzer reviewed Nov 22, 2019
View reviewed changes
doc/index.rst Outdated
@@ -53,6 +53,7 @@ This is the documentation for Matplotlib version |version|.

To get started, read the :doc:`User's Guide <users/index>`.


Copy link
Contributor

Choose a reason for hiding this comment

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

remove the change here?

@tacaswell tacaswell added this to the 3.2-doc milestone Mar 15, 2020
@tacaswell tacaswell mentioned this pull request Jul 1, 2020
Closed
6 tasks
@tacaswell tacaswell force-pushed the macosx-dev-docs-update branch from a7a734d to 9cdcad2 Compare July 1, 2020 03:06
@tacaswell tacaswell modified the milestones: 3.2-doc, v3.4.0 Jul 1, 2020
@tacaswell
BLD: use -r to point at other files in dev requirements file
e6217d0 
This makes sure they won't get out of sync
@tacaswell tacaswell requested a review from timhoffm July 1, 2020 03:12
@tacaswell tacaswell requested a review from story645 July 1, 2020 03:13
story645
story645 approved these changes Jul 1, 2020
View reviewed changes
Copy link
Member

@story645 story645 left a comment

Choose a reason for hiding this comment

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

I would prefer all the simple/easy/etc stripped out but as this is so overdue that can go into a follow up PR.

timhoffm
timhoffm reviewed Jul 1, 2020
View reviewed changes
Copy link
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

Some restructuredText formatting issues.

@tacaswell @timhoffm
DOC: correct rst markup
a5716c5 
Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
@tacaswell
Copy link
Member

Will merge if the docs come back green.

@tacaswell tacaswell merged commit 3f4d4c7 into matplotlib:master Jul 3, 2020
@tacaswell
Copy link
Member

Thanks @pambot ! Sorry this got lost in the shuffle for so long.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anntzer anntzer anntzer left review comments

@jklymak jklymak jklymak left review comments

@timhoffm timhoffm timhoffm approved these changes

@tacaswell tacaswell tacaswell approved these changes

@story645 story645 story645 approved these changes

Assignees
No one assigned
Labels
Documentation mentored: hackathon
Projects
None yet
Milestone
v3.4.0
Development

Successfully merging this pull request may close these issues.

Link to most recent DevDocs when installing from Master Source
7 participants
@pambot @tacaswell @story645 @anntzer @jklymak @timhoffm @dstansby