Skip to content
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

Improve docs #134

Merged
merged 26 commits into from
Sep 21, 2022
Merged

Improve docs #134

merged 26 commits into from
Sep 21, 2022

Conversation

addisonElliott
Copy link
Collaborator

Changes

  • Make a custom homepage for the docs that isn't the README
    • Including the README wasn't working so only the TOC was shown
    • Plus it's a little weird that the README references going to the docs when you're already there.
  • Split content up into various sections to make navigation easier
    • Background - Detailed information about using this library
    • Examples - Examples using this library
    • Reference - API reference for this library
  • Add a links section to include quick-access links, e.g. issue tracker, source code, PyPi.
  • Include note about Python 3.7+ being required for v1.0 and above of this library. Tell people they can keep using an older version of pynrrd if they need to support older Python versions
  • Update Makefile for building Sphinx docs to match template

@addisonElliott addisonElliott merged commit b9b352d into mhe:master Sep 21, 2022
@addisonElliott addisonElliott deleted the improve-docs branch September 21, 2022 23:27
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.

1 participant