Add docs #163
Merged
Add docs #163
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
|
Amazing! Very happy to merge once the docs build! |
|
Documentation hosting seems to work now. Feel free to further contribute to the documentation if you like, highly appreciated!! Happy to review! |
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 would create documentation using Github-pages. #162
To host the website, you still have to set https://juliadocs.github.io/Documenter.jl/dev/man/hosting/ documenter_key @milankl .
I noticed you had a Jupyter notebook in the docs folder. I transcripted it in a script and used Literate.jl to generate a notebook and a markdown :).
The index.md is a copy-paste of the readme.
The reference.md automatically gets the docstring from the package.