search

JuliaIntervals / TaylorModels.jl

Rigorous function approximation using Taylor models in Julia
Other
63 stars 14 forks source link

Add examples to the docs page #98

Closed mforets closed 3 years ago

mforets commented 3 years ago

This PR brings the examples script (see here) to the main docs page.

I may contribute w/other subsections to that page (example use cases that come up frequently on the issues list of this repo / on Discourse), but we can go in stages.. :)

mforets commented 3 years ago

This PR is only an update to the docs. As you may know, Documenter has a feature to push a preview of the docs if you set push_preview=true in the call to deploydocs. Otherwise, you can pull this forked branch to build the docs locally with:

$ git fetch origin pull/98/head:pr/98 && git checkout pr/98

I always forget that trick :)

mforets commented 3 years ago

@lbenet I've updated this branch with master, however i'm not sure if docs preview will work because the PR is made from my fork (I don't have rights to make it from JuliaIntervals).

lbenet commented 3 years ago

Thanks a lot; I'll take a look on them later...

I think you need to rebase to master (and push again), since #100 has been merged. this should make possible to see the preview of the docs.

mforets commented 3 years ago

I think you need to rebase to master (and push again), since #100 has been merged. this should make possible to see the preview of the docs.

yes, i did just that. about my comment on the fork is about this Note:

Pull requests made from forks will not have previews. Hosting previews requires access to the deploy key. Therefore, previews are available only for pull requests that were submitted directly from the main repository.

lbenet commented 3 years ago

Mmmm... you are right. Since the proposed changes LGTM, I guess we can simply go ahead and merge them. Is this ready?

mforets commented 3 years ago

from my side it is ready 👌

lbenet commented 3 years ago

Thanks a lot @mforets!! Merging.