-
Notifications
You must be signed in to change notification settings - Fork 71
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
Upgrade documentation and use Documenter.jl #31
Conversation
Also, add doctests blocks instead of julia code-blocks, which meant modifying few lines of the actual code.
I implemented the |
Codecov Report
@@ Coverage Diff @@
## master #31 +/- ##
=======================================
Coverage 92.14% 92.14%
=======================================
Files 22 22
Lines 917 917
=======================================
Hits 845 845
Misses 72 72 Continue to review full report at Codecov.
|
I suggest adding an auto-generated API page. |
I suggest just removing the |
Good points! I'll do that and ping you back. |
Just updated the docs following your suggestions. The auto-generated API page has an index at the beginning (which we may eventually delete or put elsewhere). The idea is to have a glance of what the docstrings cover, which is not too much (e.g., I will add cross-links in the docs to the relevant entries in the API page. |
I just pushed another commit with few crossed links and corrections (thanks to the doctests. I just noticed that some entries (in the API autogenerated page) appear repeated). I'll take a look on this later. |
That seems to be due to having several methods (e.g. for intervals and decorated intervals, I guess). I'm not sure if there's a way to consolidate them somehow. This is looking very good now, thanks! We can merge and fix that later if you prefer. |
Sorry for the late answer! I'm merging... |
The online documentation doesn't seem to have worked: https://juliaintervals.github.io/IntervalArithmetic.jl/latest |
There are errors in the doc build, which is presumably why the docs were not deployed: check https://travis-ci.org/JuliaIntervals/IntervalArithmetic.jl/jobs/232963885 and open the second |
Locally, I can't reproduce the problem; maybe it is a Documenter.jl version mistmatch. I'm checking this... |
I had an older Documenter.jl version (but not too much); in any case, locally, the doctests pass... |
This upgrades the documentation to use Documenter.jl in html format, including the use of doctests. Currently some doctests are not passing (e.g., due
@intervalbox
), but the idea is to have the framework to upgrade it gradually.