JuliaPolyhedra / Polyhedra.jl

Polyhedral Computation Interface
Other
172 stars 27 forks source link

Adds documentation example for convex_hull usage #262

Closed Hugo-Trentesaux closed 3 years ago

Hugo-Trentesaux commented 3 years ago

From issue #260

codecov[bot] commented 3 years ago

Codecov Report

Merging #262 (4bcdccd) into master (31d5996) will decrease coverage by 0.00%. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #262      +/-   ##
==========================================
- Coverage   78.08%   78.08%   -0.01%     
==========================================
  Files          39       39              
  Lines        3213     3212       -1     
==========================================
- Hits         2509     2508       -1     
  Misses        704      704              
Impacted Files Coverage Δ
src/opt.jl 83.33% <0.00%> (-0.20%) :arrow_down:

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 31d5996...4bcdccd. Read the comment docs.

blegat commented 3 years ago

Thanks, can you add the file name in https://github.com/JuliaPolyhedra/Polyhedra.jl/blob/31d59960d6edf8168bed315b4e602d42ada31f0b/docs/make.jl#L7-L11

blegat commented 3 years ago

Can you change the file name into "Convex hull of a set of points.jl" as this becomes the name visible in the documentation menu ?

Hugo-Trentesaux commented 3 years ago

Done.

But I did not write it in a form of notebook, will it work?

blegat commented 3 years ago

Yes, Literate take care of transforming it into a notebooks

blegat commented 3 years ago

You need to add CDDLib here: https://github.com/JuliaPolyhedra/Polyhedra.jl/blob/31d59960d6edf8168bed315b4e602d42ada31f0b/docs/Project.toml#L1-L2

Hugo-Trentesaux commented 3 years ago

@blegat I tried to build the documentation at home but it failed with broken pipes probably due to missing system dependencies. Where can I find the list of system dependencies needed to build the documentation? Meanwhile, I added CDDLib inside the docs Project.toml file. I hope it works.

schillic commented 3 years ago

Where can I find the list of system dependencies needed to build the documentation?

The Julia packages are listed here:

https://github.com/JuliaPolyhedra/Polyhedra.jl/blob/31d59960d6edf8168bed315b4e602d42ada31f0b/docs/Project.toml#L2-L7

Hugo-Trentesaux commented 3 years ago

Julia package are not the problem. I was talking about the non-Julia libraries (like jupyter notebook, cdd) for which Julia only provides a binding.

blegat commented 3 years ago

CDDLib has cddlib_jll as a requirement: https://github.com/JuliaPolyhedra/CDDLib.jl/blob/master/Project.toml#L21 cddlib_jll contains the cddlib compiled binary, see https://pkgdocs.julialang.org/v1/artifacts/.