Automated documentation creation&publishing to GH-pages by dorukaks · Pull Request #35 · PinguDevTeam/ICF-MI-framework

dorukaks · 2022-11-29T14:02:22Z

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.

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
I have addressed all the issues entirely

There will be A LOT of commits while testing this feature be ready...

sahilbhola14 · 2022-11-30T06:05:45Z

Alright Alright Alright! It's working

sahilbhola14 · 2022-11-30T06:09:37Z

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 · 2022-11-30T06:11:07Z

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

dorukaks · 2022-11-30T12:09:35Z

Alright Alright Alright! It's working

dorukaks · 2022-11-30T12:50:28Z

@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

commit f35355a Merge: fbb7d23 339ce03 Author: sahilbhola14 <sbhola@umich.edu> Date: Tue Nov 29 19:51:59 2022 -0500 Merge branch 'main' of github.com:PinguDevTeam/ICF-MI-framework into main commit fbb7d23 Merge: 90ec97b 8b8c071 Author: sahilbhola14 <sbhola@umich.edu> Date: Mon Nov 28 14:43:07 2022 -0500 Merge branch 'main' of github.com:PinguDevTeam/ICF-MI-framework into main

dorukaks · 2022-12-02T17:21:48Z

@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 · 2022-12-04T04:28:42Z

@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

* (test) create initial .yml file to test function There will be A LOT of commits while testing this feature be ready... * (test) create sphinx .yml file to test function * (fix) add installation of sphinx-rtd-theme * (fix) change sphinx-action repository version * (fix) change repo versions for actions * (test) create environment for auto docs * (fix) change theme installation sequence * (test) change rtd_theme import style * (fix) change requirement declaration * (fix) correct id in deploy step * (test) try publishing documentation * (test) tweak action workflow to publish pages * (test) moved autoDocs to avoid build confusion * (fix) change artifact path * (fix) change artifact path * (test) create an empty file to create html folder * (test) change workflow options to make this work * (fix) change build command according to sphinx issues * (fix) indicate config file location in workflow * (fix) indicate config file location in workflow * (fix) change build command * (fix) change build command * (fix) change build command * (fix) change artifact build path * (fix) correct the hyperlink on introduction.rst * (fix) change insrted path from gim to src * (fix) create requirements.txt for whole pipeline * (docs) create links for packages * (test) write a test function into TTICE for docs * (test) create TTICE.rst to test autodocs * (test) change directory path in index.rst * (test) change directory path in index.rst * (test): Change sphinx (GH action) build command Changed the sphinx build command to `make html` * (test): Add sphinx api build to GH actions Added sphinx api build command for building * (test): Change build-command to run for Sphinx Changed the build command to run for sphinx gh action * (refactor) Delete redundant files Delete the following files: requirements.txt environment.yml * (reformat): Remane the sphinx workflow sphinx workflow was renamed to createDocumentation * (feat): Add sphinx build check workflow Added sphinx build check workflow * (refactor) remove redundant module calls in index Removed redundant module calls in index.rst * (wip) Check pre-build command for sphinx-action * (fix) Fix typo for pre-build-command * (feat) Add souce code read in pre-build sphinx * (WIP) Add pre-build comamnd for sphinx-api * (WIP) Test run command on git actions * (feat) Add pre-build source code * (fix) Fix doc to docs * (fix) Fix pre-build rm command * (fix) Remove firefox pop-up and latex build * (feat) Add install dependancies for sphinx * (feat) Upload artifacts for the html documentation * (feat) Add pages deploy * (feat) upload artifacts * (fix) Correct artifact path * (fix) Correct publish_dir * (feat) Add Manual push to gh-pages * (refactor) Remove autoDocs.yml * (refactor) Remove comment from createDocumentation * Squashed commit of the following: commit f35355a Merge: fbb7d23 339ce03 Author: sahilbhola14 <sbhola@umich.edu> Date: Tue Nov 29 19:51:59 2022 -0500 Merge branch 'main' of github.com:PinguDevTeam/ICF-MI-framework into main commit fbb7d23 Merge: 90ec97b 8b8c071 Author: sahilbhola14 <sbhola@umich.edu> Date: Mon Nov 28 14:43:07 2022 -0500 Merge branch 'main' of github.com:PinguDevTeam/ICF-MI-framework into main * (fix) Add source code path to conf Co-authored-by: sahilbhola14 <sbhola@umich.edu>

(test) create initial .yml file to test function

aa92b68

There will be A LOT of commits while testing this feature be ready...

dorukaks added documentation Improvements or additions to documentation enhancement New feature or request chore General chores for the repository labels Nov 29, 2022

dorukaks added this to the Documentation milestone Nov 29, 2022

dorukaks self-assigned this Nov 29, 2022

dorukaks added 10 commits November 29, 2022 09:12

(test) create sphinx .yml file to test function

c6b143b

(fix) add installation of sphinx-rtd-theme

a81af2c

(fix) change sphinx-action repository version

e1ab345

(fix) change repo versions for actions

291148c

(test) create environment for auto docs

52944ec

(fix) change theme installation sequence

3532402

(test) change rtd_theme import style

772751e

(fix) change requirement declaration

1f267a7

(fix) correct id in deploy step

8321ea7

(test) try publishing documentation

f5bbd46

dorukaks had a problem deploying to github-pages November 29, 2022 15:56 Failure

(test) tweak action workflow to publish pages

ce1136b

dorukaks temporarily deployed to github-pages November 29, 2022 16:01 Inactive

(test) moved autoDocs to avoid build confusion

ebf7cd3

dorukaks temporarily deployed to github-pages November 29, 2022 16:06 Inactive

dorukaks added 9 commits November 29, 2022 11:14

(fix) change artifact path

4d58ff9

(fix) change artifact path

2553e8c

(test) create an empty file to create html folder

b738a99

(test) change workflow options to make this work

1ff0e0f

(fix) change build command according to sphinx issues

e46c5c7

(fix) indicate config file location in workflow

4bd7d57

(fix) indicate config file location in workflow

5c03483

(fix) change build command

d3c5409

(fix) change build command

8d15489

sahilbhola14 had a problem deploying to github-pages November 30, 2022 05:02 Failure

(fix) Correct artifact path

8dfb1f4

sahilbhola14 had a problem deploying to github-pages November 30, 2022 05:03 Failure

sahilbhola14 added 2 commits November 30, 2022 00:13

(fix) Correct publish_dir

6affc42

(feat) Add Manual push to gh-pages

d042164

sahilbhola14 self-assigned this Nov 30, 2022

sahilbhola14 added 2 commits November 30, 2022 01:01

(refactor) Remove autoDocs.yml

d23c169

(refactor) Remove comment from createDocumentation

c21dc39

sahilbhola14 marked this pull request as ready for review November 30, 2022 06:08

dorukaks requested review from camckenn, cfkawa and sahilbhola14 November 30, 2022 12:49

cfkawa approved these changes Nov 30, 2022

View reviewed changes

sahilbhola14 requested changes Nov 30, 2022

View reviewed changes

Comment thread docs/conf.py Outdated

Comment thread src/TTICE/__init__.py

sahilbhola14 added 2 commits November 30, 2022 20:11

(fix) Add source code path to conf

e85ceae

sahilbhola14 marked this pull request as draft December 1, 2022 15:45

camckenn approved these changes Dec 1, 2022

View reviewed changes

dorukaks mentioned this pull request Dec 2, 2022

LSTM tutorial using airline passenger data #38

Open

9 tasks

sahilbhola14 marked this pull request as ready for review December 4, 2022 04:28

sahilbhola14 approved these changes Dec 4, 2022

View reviewed changes

sahilbhola14 merged commit 2c17238 into main Dec 4, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Automated documentation creation&publishing to GH-pages#35

Automated documentation creation&publishing to GH-pages#35
sahilbhola14 merged 60 commits into
mainfrom
feat/doruk/31

dorukaks commented Nov 29, 2022 •

edited by sahilbhola14

Loading

Uh oh!

sahilbhola14 commented Nov 30, 2022

Uh oh!

sahilbhola14 commented Nov 30, 2022

Uh oh!

sahilbhola14 commented Nov 30, 2022 •

edited

Loading

Uh oh!

dorukaks commented Nov 30, 2022

Uh oh!

dorukaks commented Nov 30, 2022

Uh oh!

Uh oh!

Uh oh!

dorukaks commented Dec 2, 2022

Uh oh!

sahilbhola14 commented Dec 4, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

dorukaks commented Nov 29, 2022 • edited by sahilbhola14 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose

Items

Type of change

Checklist

Uh oh!

sahilbhola14 commented Nov 30, 2022

Uh oh!

sahilbhola14 commented Nov 30, 2022

Uh oh!

sahilbhola14 commented Nov 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dorukaks commented Nov 30, 2022

Uh oh!

dorukaks commented Nov 30, 2022

Uh oh!

Uh oh!

Uh oh!

dorukaks commented Dec 2, 2022

Uh oh!

sahilbhola14 commented Dec 4, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

dorukaks commented Nov 29, 2022 •

edited by sahilbhola14

Loading

sahilbhola14 commented Nov 30, 2022 •

edited

Loading