Docs/add tutorial #348
Merged
Docs/add tutorial #348
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bdice
force-pushed
the
docs/add_tutorial
branch
from
af5c8d8
to
717cad3
Compare
Codecov Report
@@ Coverage Diff @@
## next #348 +/- ##
=======================================
Coverage ? 90.43%
=======================================
Files ? 17
Lines ? 2071
Branches ? 19
=======================================
Hits ? 1873
Misses ? 188
Partials ? 10Continue to review full report at Codecov.
|
bdice
force-pushed
the
docs/add_tutorial
branch
from
717cad3
to
5746017
Compare
|
Need to add docs for #395, specifically how the query arguments work. |
vyasr
force-pushed
the
docs/add_tutorial
branch
from
5746017
to
8fde631
Compare
vyasr
changed the base branch from
next
to
refactor/update_locality_matchenv_apis
vyasr
changed the base branch from
refactor/update_locality_matchenv_apis
to
next
bdice
reviewed
Oct 2, 2019
| 'numpy': ('https://docs.scipy.org/doc/numpy', None), | ||
| 'matplotlib': ('https://matplotlib.org', None), | ||
| 'hoomd': ('https://hoomd-blue.readthedocs.io/en/stable/', None), | ||
| } | ||
|
|
||
| autodoc_mock_import = ["numpy"] |
There was a problem hiding this comment.
I don't think this is needed anymore? We have intersphinx mapping, so I don't think we have to fake it with mock imports. Not sure.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds more documentation to the package, starting with an introduction to what freud is, a quick start guide, and a more detailed tutorial. This PR should not be merged until all of the neighbor finding refactoring is complete, since we need to verify that all the APIs, etc are correct.
Motivation and Context
Our current documentation only includes API information, but has no guidance for users on how to start out using freud. This PR addresses that need.
Also resolves #274 as much as we can; I suggest fleshing that section out as we receive questions on specific other data formats people want to read into freud.
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: