Automated documentation creation&publishing to GH-pages

PinguDevTeam / ICF-MI-framework

Model identifiability pipeline using surrogate models trained on a latent space extracted by tensor decompositions.

https://pingudevteam.github.io/ICF-MI-framework/

MIT License

0 stars 0 forks source link

Automated documentation creation&publishing to GH-pages #35

Closed dorukaks closed 1 year ago

dorukaks commented 1 year ago

Purpose

Create GitHub actions to automatically create documentation of the pipeline and publish the created documentation on GitHub pages.

Closes #31

Items

Automate the documentation pipeline
Publish documentation to GitHub pages

Type of change

New feature (non-breaking change which adds functionality)
Repository chores (changes made to improve repository/workflow quality)
Documentation update

Checklist

Put an x in the boxes that apply.

[x] My code functions as intended
[ ] I have used camelCase in my variable and function names
[ ] I have commented my code properly
[ ] I have provided the necessary prompts for automatic documentation
[ ] I have provided a toy case under the examples folder
[x] I have addressed all the issues entirely

dorukaks commented 1 year ago

I'VE DONE IT

dorukaks commented 1 year ago

@sahilbhola14 need you to have a look to confirm the behavior of the github pages, if it's producing expected behavior, we can mark this as ready to review :+1:

sahilbhola14 commented 1 year ago

Great job @dorukaks. It seems the modules are missing, i.e. the main code-base is not being documented

dorukaks commented 1 year ago

Great job @dorukaks. It seems the modules are missing, i.e. the main code-base is not being documented

is it normally getting created when you run it locally?

sahilbhola14 commented 1 year ago

Alright Alright Alright! It's working

sahilbhola14 commented 1 year ago

CAUTION: Since this PR has a lot of commits, it might be more suitable to squash while doing the merge. Let me know if help is needed :)

sahilbhola14 commented 1 year ago

@dorukaks Lets merge this to main only and then freeze main. Update the dev and then start working?

dorukaks commented 1 year ago

Alright Alright Alright! It's working

dorukaks commented 1 year ago

@dorukaks Lets merge this to main only and then freeze main. Update the dev and then start working?

Allright! Once we get approvals from @camckenn @cfkawa, I'll perform a squash merge and then lock main

dorukaks commented 1 year ago

@sahilbhola14 I pruned @cfkawa's branches and re-run the build job, currently the documentation page looks functional. If you confirm this, we can merge to main and freeze main.

sahilbhola14 commented 1 year ago

@sahilbhola14 I pruned @cfkawa's branches and re-run the build job, currently the documentation page looks functional. If you confirm this, we can merge to main and freeze main.

@dorukaks seems like it's working, we can close the PR