-
Notifications
You must be signed in to change notification settings - Fork 641
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
Read the docs #55
Merged
Merged
Read the docs #55
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
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.
Revised documentation tree including Ardavan's edits. The source files live in
meep/doc/docs
. Inmeep/doc/README
I wrote some simple instructions for how to build and serve the documentation tree locally (on your laptop or workstation) while editing the sources files to preview what the built documentation will look like.See the full built documentation tree on ReadTheDocs:
http://meep.readthedocs.io/en/latest/Meep/
This is currently linked to my GitHub repository, but after this pull request we can redirect that to the main (Steven's) meep repository. Then commits to the documentation source tree will be automatically reflected to the built documentation at ReadTheDocs.
@oskooi @stevengj @ChristopherHogan