rafaqz / DimensionalData.jl

Named dimensions and indexing for julia arrays and other data
https://rafaqz.github.io/DimensionalData.jl/stable/
MIT License
274 stars 39 forks source link

Docs build issues #648

Closed asinghvi17 closed 7 months ago

asinghvi17 commented 7 months ago
rafaqz commented 7 months ago

Lots of those docs do exist tho... maybe in modules

lazarusA commented 7 months ago

maybe we should include something here https://github.com/rafaqz/DimensionalData.jl/blob/e65dcf95db6f75b39f0e0d892ab7c68b240bcd94/docs/make.jl#L4 like this

DocMeta.setdocmeta!(DimensionalData, :DocTestSetup, :(using DimensionalData.Modules); recursive=true)

see https://documenter.juliadocs.org/stable/lib/public/#Documenter.DocMeta.setdocmeta!.

so that the whole thing is available everywhere. However, I don't like it that much because then we are not forced to specify from where we are using functions in the examples. But it's necessary when using references in the text.

This is use in DataFrames

https://github.com/JuliaData/DataFrames.jl/blob/d7f27e6695c147ca065901f607cdf26559bea602/docs/make.jl#L5

rafaqz commented 7 months ago

Fixed