Skip to content
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

Merged
merged 5 commits into from
May 16, 2017
Merged

Upgrade documentation and use Documenter.jl #31

merged 5 commits into from
May 16, 2017

Conversation

lbenet
Copy link
Member

@lbenet lbenet commented May 15, 2017

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.

Luis Benet added 2 commits May 14, 2017 21:02
Also, add doctests blocks instead of julia code-blocks, which
meant modifying few lines of the actual code.
@lbenet
Copy link
Member Author

lbenet commented May 15, 2017

I implemented theTaylorSeries.jl docs using the repl mode to get the answers automatic. It is certainly possible to change the testing of docstring to the repl mode here, but being in a time of many changes, I think it is safer to test the docstrings.

@codecov-io
Copy link

codecov-io commented May 15, 2017

Codecov Report

Merging #31 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c0bb130...cb5d490. Read the comment docs.

@dpsanders
Copy link
Member

I suggest adding an auto-generated API page.

@dpsanders
Copy link
Member

I suggest just removing the @intervalbox stuff from the docs.

@lbenet
Copy link
Member Author

lbenet commented May 15, 2017

Good points! I'll do that and ping you back.

@lbenet
Copy link
Member Author

lbenet commented May 15, 2017

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., Interval is not documented!).

I will add cross-links in the docs to the relevant entries in the API page.

@lbenet
Copy link
Member Author

lbenet commented May 15, 2017

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.

@dpsanders
Copy link
Member

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.

@lbenet
Copy link
Member Author

lbenet commented May 16, 2017

Sorry for the late answer! I'm merging...

@lbenet lbenet merged commit 698e64b into master May 16, 2017
@dpsanders
Copy link
Member

The online documentation doesn't seem to have worked: https://juliaintervals.github.io/IntervalArithmetic.jl/latest

@dpsanders
Copy link
Member

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 Documenter tab (a right-pointing triangle) at the bottom.

@lbenet
Copy link
Member Author

lbenet commented May 17, 2017

Locally, I can't reproduce the problem; maybe it is a Documenter.jl version mistmatch. I'm checking this...

@lbenet
Copy link
Member Author

lbenet commented May 17, 2017

I had an older Documenter.jl version (but not too much); in any case, locally, the doctests pass...

@lbenet lbenet mentioned this pull request May 18, 2017
@lbenet lbenet deleted the documenter branch May 18, 2017 20:31
@dpsanders dpsanders changed the title WIP: Upgrade documentation and use Documenter.jl Upgrade documentation and use Documenter.jl May 19, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants