Documentation: finish quickstart and add installation instructions #324
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
…ion of CLI arguments
… command line flag
…lines, which is just a symlink to the main repository\'s contributing.md file.
This was referenced Aug 20, 2020
Closed
naveen521kk
requested changes
Aug 21, 2020
Aathish04
requested changes
Aug 21, 2020
safinsingh
suggested changes
Aug 21, 2020
Co-authored-by: Naveen M K <naveen@syrusdark.website>
added explanation on the ``-s`` flag
Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>
Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>
Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>
Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>
Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>
leotrs
commented
Aug 21, 2020
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.
This PR adds two new tutorials: the quickstart and "a deeper look", which documents the output folder structure.
I also copied all of the installation instructions currently in README.md and put them in the documentation, and added a stub Troubleshooting page. (For this, I created a few symlinks from readme-assets to the documentation source folder.)
Finally, I added a new hidden toctree in the references page so that sphinx would stop shouting at me.
See the git messages for detailed list of changes.
EDIT: As always, feel free to nitpick, but also please keep in mind that these documents are meant to be starting points.
EDIT2: Once this is merged an a ReadTheDocs site is up, we can delete all of the installation instructions from the README.md (which currently look pretty badly formatted IMO, and we can just direct people to the RTD site).