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

Updates to the documentation #129

Merged
merged 5 commits into from
Oct 22, 2020
Merged

Conversation

kaustubhmote
Copy link
Collaborator

This PR updates the documentation at these places:

  1. New functions in fileio.simpson.py and fileio.bruker.py catalogued
  2. A new file for documenting misc.xcpy.py
  3. Updated installation instructions and requirements (install.rst)
  4. Updated tutorial.rst (correct links, more information on filetypes that nmrglue can handle)
  5. Updated instructions to use matplotllib in tutorial.rst

@kaustubhmote
Copy link
Collaborator Author

There are several other places where the documentation needs to be updated, and I'll get to those eventually. But this is what I already had ready, and since the plan is to cut version 0.8 soon, these could possibly go in.

doc/source/install.rst Outdated Show resolved Hide resolved
doc/source/install.rst Outdated Show resolved Hide resolved
@jjhelmus
Copy link
Owner

Thanks for putting this together. Looks good overall. I added two comments on minor changes.

- The recommended version of numpy is set to 1.16
- Windows installation now recommends Anaconda/Miniconda
- Several typos corrected
@jjhelmus
Copy link
Owner

LGTM, thanks for the update.

@jjhelmus jjhelmus merged commit 15555d7 into jjhelmus:master Oct 22, 2020
@kaustubhmote kaustubhmote deleted the documentation branch December 1, 2021 05:17
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.

2 participants