Skip to content

General clean up of existing docs #120

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 9 commits into from
May 18, 2023
Merged

General clean up of existing docs #120

merged 9 commits into from
May 18, 2023

Conversation

dstansby
Copy link
Member

  • Add --keep-going option to sphinx so it keeps going and reports all errors instead of stopping at the first error
  • Add nitpicky = True to sphinx, to raise an error if any links (internal or external) are broken
  • And some more intersphinx mappings to get external links working
  • Minor improvements to the API docs
  • Make some of the Slice widget API private that shouldn't be public

@dstansby dstansby added the Docs Improvements or additions to documentation label May 18, 2023
@dstansby dstansby added this to the 0.3.0 milestone May 18, 2023
@dstansby dstansby marked this pull request as ready for review May 18, 2023 10:35
@dstansby dstansby requested review from ruaridhg and samcunliffe May 18, 2023 10:35
ruaridhg
ruaridhg approved these changes May 18, 2023
View reviewed changes
Copy link
Collaborator

@ruaridhg ruaridhg left a comment

Choose a reason for hiding this comment

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

LGTM

ruaridhg
ruaridhg approved these changes May 18, 2023
View reviewed changes
Copy link
Collaborator

@ruaridhg ruaridhg left a comment

Choose a reason for hiding this comment

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

LGTM

@ruaridhg ruaridhg added this pull request to the merge queue May 18, 2023
Merged via the queue into matplotlib:main with commit 51b6b03 May 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ruaridhg ruaridhg ruaridhg approved these changes

@samcunliffe samcunliffe Awaiting requested review from samcunliffe

Assignees

No one assigned

Labels

Docs Improvements or additions to documentation

Projects

None yet

Milestone

1.0.0

Development

Successfully merging this pull request may close these issues.

2 participants

@dstansby @ruaridhg