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

new vitepress docs #616

Closed lazarusA closed 7 months ago

lazarusA commented 8 months ago

build docs locally:

Install Node dependencies:

DimensionalData> npm i

then install Julia dependencies

cd docs

type

julia

activate

] activate .

add packages:

] add https://github.com/LuxDL/DocumenterVitepress.jl.git
] add Documenter
] dev ../

then generate docs by running the make.jl file.

Then run a live server from the main directory, namely

DimensionalData> npm run docs:dev 
lazarusA commented 8 months ago

Some previews:

Screenshot 2024-02-07 at 23 32 25 Screenshot 2024-02-07 at 23 32 48
codecov-commenter commented 7 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (1ee6424) 86.86% compared to head (2ab06c6) 86.80%.

:exclamation: Current head 2ab06c6 differs from pull request most recent head 731f955. Consider uploading reports for the commit 731f955 to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #616 +/- ## ========================================== - Coverage 86.86% 86.80% -0.06% ========================================== Files 44 44 Lines 3669 3669 ========================================== - Hits 3187 3185 -2 - Misses 482 484 +2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

lazarusA commented 7 months ago

@rafaqz please, delete gh-pages branch. No need it anymore. And then active deployment from main on gh-pages, please.

Screenshot 2024-02-13 at 23 54 05
rafaqz commented 7 months ago

Whaaa how dies that work?

lazarusA commented 7 months ago

what? nothing is failing now if I ignore dead links :D .

Ah, yes, this still deploys using gh-pages actions, but from main. At least that's how I know how to do it. The other workflow will be to push to gh-pages and then deploy again from there in order to build the docs, unfortunately I haven't been able to do double deploys, specially from the gh-pages branch.

rafaqz commented 7 months ago

Ok so what do I need to do?

rafaqz commented 7 months ago

Heres the logo: