Skip to content

Documentation: make instructions for documentation contributions easier to find, add to requirements for building docs #16779

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

Merged
merged 4 commits into from
Mar 17, 2020

Conversation

pibion
Copy link
Contributor

@pibion pibion commented Mar 15, 2020

PR Summary

These changes make the documentation contribution instructions a little easier to find, make it clearer which folders contain primary documentation sources, and add to the requirements for building the documentation.

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

@tacaswell tacaswell added this to the 3.2-doc milestone Mar 15, 2020
@tacaswell
Copy link
Member

The failure is a race condition (and should be fixed by #16693 ).

Copy link
Member

@tacaswell tacaswell left a comment

Choose a reason for hiding this comment

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

👍 thanks @pibion !

@pibion
Copy link
Contributor Author

pibion commented Mar 16, 2020

Thanks for reviewing @tacaswell!

Is there any action needed from me before merging? Should I merge in the fix to the race condition?

just tried to reorg the bit under general file structure to be a little clearer
@pibion
Copy link
Contributor Author

pibion commented Mar 17, 2020

Thanks @story645 this edit is a nice improvement!

@story645 story645 merged commit 2c845db into matplotlib:master Mar 17, 2020
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Mar 17, 2020
…cumentation contributions easier to find, add to requirements for building docs
QuLogic added a commit that referenced this pull request Mar 17, 2020
…779-on-v3.2.0-doc

Backport PR #16779 on branch v3.2.0-doc (Documentation: make instructions for documentation contributions easier to find, add to requirements for building docs)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants