Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support devcontainer, refactor GitHub acitons, add documentation #92

Merged
merged 5 commits into from
Dec 7, 2023
Merged

Support devcontainer, refactor GitHub acitons, add documentation #92

merged 5 commits into from
Dec 7, 2023

Conversation

cameronrutherford
Copy link
Collaborator

@cameronrutherford cameronrutherford commented Nov 29, 2023 •
edited by pelesh
Loading

Implements:

  • Refactor of GitHub action to avoid custom action
  • Devcontainer support for building/testing docs within container

Closes:

As well as documenting new features added in this PR

@ryandanehy

@cameronrutherford
Copy link
Collaborator Author

Code refactor of CI works. Will add docs to close #11 and #75

ryandanehy
ryandanehy approved these changes Nov 29, 2023
View reviewed changes
Copy link
Collaborator

@ryandanehy ryandanehy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really cool stuff, and save me some red tape so nice work.

This was linked to issues Nov 29, 2023
Are the documentation Makefiles used anywhere? #81
Closed
Document ReSolve Spack packaging #11
Closed
Document CI/CD configurations and build scripts #75
Closed
@cameronrutherford cameronrutherford self-assigned this Nov 29, 2023
@cameronrutherford cameronrutherford changed the title Add devcontainer working build and pipeline for docs without action. Support devcontainer, refactor GitHub acitons, add documentation Nov 29, 2023
cameronrutherford
cameronrutherford commented Nov 29, 2023
View reviewed changes
docs/conf.py Outdated Show resolved Hide resolved
@cameronrutherford cameronrutherford linked an issue Nov 29, 2023 that may be closed by this pull request
Duplicates of CONTRIBUTING and LICENSE files. #80
Closed
@cameronrutherford cameronrutherford marked this pull request as ready for review November 29, 2023 23:28
@cameronrutherford
Copy link
Collaborator Author

Ready for review and also hopefully merging soon!

@cameronrutherford cameronrutherford requested review from AddiMT and kswirydo and removed request for AddiMT November 30, 2023 01:21
@cameronrutherford cameronrutherford mentioned this pull request Dec 1, 2023
Merged
@pelesh pelesh added this to the First Release milestone Dec 1, 2023
pelesh
pelesh requested changes Dec 1, 2023
View reviewed changes
Copy link
Collaborator

@pelesh pelesh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great PR with much needed changes. Only minor tweaks needed.

  • If we are removing deprecated options in Doxyfile.in, we should remove the descriptions of those options. Otherwise, it may be too confusing for a maintainer who may look at this a few months later.
  • Do we have instructions somewhere how to build documentation in the docker? That would be helpful for other developers.

.devcontainer/devcontainer.json Show resolved Hide resolved
docs/doxygen/Doxyfile.in Show resolved Hide resolved
ryandanehy
ryandanehy approved these changes Dec 5, 2023
View reviewed changes
Copy link
Collaborator

@ryandanehy ryandanehy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor even inconsequence suggest, but overall still great.

.github/workflows/documentation.yml Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
@ryandanehy
Copy link
Collaborator

ryandanehy commented Dec 6, 2023 •
edited
Loading

@pelesh I think this is good to merge. I added instructions for running the dev container in index.rst. LGTM

pelesh
pelesh requested changes Dec 6, 2023
View reviewed changes
Copy link
Collaborator

@pelesh pelesh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! The only missing thing is to restore doxygen-awesome stylesheet.

docs/conf.py Show resolved Hide resolved
docs/doxygen/Doxyfile.in Outdated Show resolved Hide resolved
docs/doxygen/Doxyfile.in Outdated Show resolved Hide resolved
@pelesh
Copy link
Collaborator

pelesh commented Dec 7, 2023

I get following error when I try to create a container:

[80546 ms] * Processing feature: ghcr.io/devcontainers/features/common-utils:2
[80785 ms] Error: self signed certificate in certificate chain

@cameronrutherford @ryandanehy: Do you know what this means?

@cameronrutherford
Copy link
Collaborator Author

I get following error when I try to create a container:


[80546 ms] * Processing feature: ghcr.io/devcontainers/features/common-utils:2

[80785 ms] Error: self signed certificate in certificate chain

@cameronrutherford @ryandanehy: Do you know what this means?

Are you on VPN?

@pelesh
Copy link
Collaborator

pelesh commented Dec 7, 2023

Are you on VPN?

Yes, I was. I'll try w/o VPN.

@pelesh pelesh mentioned this pull request Dec 7, 2023
Closed
@pelesh pelesh merged commit 7b3ca5b into develop Dec 7, 2023
6 checks passed
@pelesh pelesh mentioned this pull request Dec 7, 2023
Closed
@pelesh pelesh deleted the doc-update-dev branch February 21, 2024 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ryandanehy ryandanehy ryandanehy approved these changes

@pelesh pelesh pelesh approved these changes

@kswirydo kswirydo Awaiting requested review from kswirydo

Assignees

@cameronrutherford cameronrutherford

Labels
None yet
Projects
None yet
Milestone
First Release
3 participants
@cameronrutherford @ryandanehy @pelesh