Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

fix: minor changes to docs #125

Merged
merged 9 commits into from
Apr 20, 2023
Merged

Conversation

ekauffma
Copy link
Collaborator

  • Fixed a few typos
  • Title edits for readthedocs tab
  • Removed "suggest edit" button (does not work with notebook symlinks and "open issue" button should be sufficient)
  • Edited exclude pattern list in readthedocs configuration file to avoid warnings when building with sphinx
  • Edited output of docs/event-plotting/plotEvents.ipynb
  • Added badge for documentation in README

@ekauffma ekauffma requested a review from alexander-held April 20, 2023 09:33
Copy link
Member

@alexander-held alexander-held left a comment

Choose a reason for hiding this comment

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

Could we please add a (non-badge) documentation link to the readme as well, perhaps next to the "we also have a dedicated webpage" link?

Copy link
Member

@alexander-held alexander-held left a comment

Choose a reason for hiding this comment

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

Thank you!

@alexander-held alexander-held merged commit 5bcbe66 into iris-hep:main Apr 20, 2023
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants