Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Updates to the documentation#129

Merged
jjhelmus merged 5 commits into
jjhelmus:masterfrom
kaustubhmote:documentation
Oct 22, 2020
Merged

Updates to the documentation#129
jjhelmus merged 5 commits into
jjhelmus:masterfrom
kaustubhmote:documentation

Conversation

@kaustubhmote
Copy link
Copy Markdown
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
Copy Markdown
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.

Comment thread doc/source/install.rst Outdated
Comment thread doc/source/install.rst Outdated
@jjhelmus
Copy link
Copy Markdown
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
Copy Markdown
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