Add Documenter built docs #285
Merged
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
Set up doctests to start with 'using Interpolations'
To better control which part of the docs are going where, I moved the @autodocs blocks to api.md. I also added installation info to index.md
To better control the order of the documentation and to have all relevant information in the docs, I shortened the README and put all information into the docs/ folder.
Use pages keyword of makedocs() to set the order of the docs.
Codecov Report
@@ Coverage Diff @@
## master #285 +/- ##
=======================================
Coverage 47.36% 47.36%
=======================================
Files 21 21
Lines 1064 1064
=======================================
Hits 504 504
Misses 560 560Continue to review full report at Codecov.
|
timholy
reviewed
Dec 17, 2018
docs/make.jl
Outdated
| "Library" => "api.md"] | ||
| ) | ||
|
|
||
| deploydocs(repo="github.com/felixcremer/Interpolations.jl") |
There was a problem hiding this comment.
I've done the necessary key setup for JuliaMath/Interpolations.jl, so you should be able to change this to point to this repo.
There was a problem hiding this comment.
Changed. The documentation will only be built when the changes are merged, because the docs deployment is pointing on the master branch.
Change Documenter version to 0.21.0 to allow local nonprettyurls Fix link to convenience-notation
|
Thanks for the comments, I think this is now good to merge. |
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 sets up Documenter built docs. These are at the moment visible at
https://felixcremer.github.io/Interpolations.jl/dev/
I split the README into small .md files in the docs/ folder and added these into the documentation.
I also included the docstrings at the end under Library splitted into Public and Internal API.
See also #273 for a discussion on the docstrings.
I think the docs need further work, and this could be a good starting point to see what docstrings are already there.
Somebody with a better understanding of the internals would need to check which parts of the doc/ folder is still relevant and need to be included.