search

ProjectTorreyPines / IMASdd.jl

Basic data dictionary functionalities of IMAS.jl
https://projecttorreypines.github.io/IMASdd.jl/
Apache License 2.0
3 stars 0 forks source link

CI generated online documentation #10

Closed anchal-physics closed 4 months ago

anchal-physics commented 4 months ago

Workflow has been added to generate documentation and deplot to gh-pages whenever a new release with a version number is generated (goes to stable documentation) and when master branch is updated with a push or PR.

orso82 commented 4 months ago

This works! Thank you so much @anchal-physics !!

anchal-physics commented 4 months ago

You're welcome. Please note that stable online documentation would only be generated once you create a tagged release with version number. Currently this link on the README page is broken.

orso82 commented 4 months ago

I'd be ok to tag current version 0.1.0. Have you published your other packages to the Julia registry?

anchal-physics commented 4 months ago

No, I can not publish them to Julia registry yet since IMASDD is a dependency and it is not available at Julia registry. So I need IMASDD published before I can publish other packages.

orso82 commented 4 months ago

Let's publish all of them then. Have you looked into how that works? I have not.

anchal-physics commented 4 months ago

Yesh, I have. You need to install registrator bot to your repository which are a few clicks. Then open a new issue and comment following to it:

@JuliaRegistrator register()

I have already tried it on https://github.com/ProjectTorreyPines/GGDUtils.jl/issues/47 and that's how I know that IMASDD needs to be registered first.

source: https://julialang.org/contribute/developing_package/#step_5_register_your_package