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.

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

Update Doxygen html documentation output on Moltres #148

Merged
merged 4 commits into from
Feb 4, 2021

Conversation

smpark7
Copy link
Collaborator

@smpark7 smpark7 commented Jan 28, 2021

Closes #146

This PR updates the Doxygen html documentation on Moltres, which is hosted here and was last updated in 2017.

This PR also corrects LaTeX syntax typos in the documentation in FissionHeatSourceAux.h and DiffusionNoBCBC.h.

@yardasol
Copy link
Contributor

@smpark7 Do you have any recommendations on how I can review this PR? There are over 1000 files edited and I have no idea where to start.

@katyhuff
Copy link
Member

Something is failing in the MOOSE CIVET tests. Unclear to me why. It seems to be missing user info necessary for cleaning up the ubuntu 16 instance?

...
//: cp /home/moosetest/singularity/start_moosebuild.sh /home/moosetest/singularity/.civet_buildq11_start_moosebuild.PfRml
//: source /home/moosetest/singularity/.civet_buildq11_start_moosebuild.PfRml
whoami: cannot find name for user ID 1002: Connection refused
/home/moosetest/singularity/.civet_buildq11_start_moosebuild.PfRml: line 682: [: =: unary operator expected
//: Instructing Singularity to use environment set forth by Civet
//: mkdir -p /tmp/Ubuntu-16
//: chmod o-rwx /tmp/Ubuntu-16
//: mapping /tmp/Ubuntu-16 as /tmp within container
whoami: cannot find name for user ID 1002: Connection refused
/home/moosetest/singularity/.civet_buildq11_start_moosebuild.PfRml: line 323: [: =: unary operator expected
//: Using moose-environment release: 6f3c438e838564d48bf591191986ef747f50c8e1
//: ARCH=Ubuntu-16.04
//: BUILD_DATE=20191104
//: PR_VERSION=https://github.com/idaholab/package_builder/pull/213
//: rm /home/moosetest/singularity/.civet_buildq11_start_moosebuild.PfRml
//: cp /tmp/tmp0yJ9cK /tmp/Ubuntu-16/
/tmp/: /opt/singularity/bin/singularity exec --no-home /home/moosetest/singularity/containers/Ubuntu-16.simg /tmp/tmp0yJ9cK
ERROR  : Failed to obtain user identity information
ABORT  : Retval = 255
/tmp/: rm -rf /tmp/Ubuntu-16```

@smpark7
Copy link
Collaborator Author

smpark7 commented Jan 29, 2021

Yea I'm not sure why the test failed in such a way either. The error message seems to suggest it wasn't anything in Moltres that triggered it.

@yardasol The only real changes in documentation are in FissionHeatSourceAux.h and DiffusionNoBCBC.h (fixing typos). All other changes seem like formatting changes from using a newer Doxygen version (1.8.13 -> 1.8.17). I think it is safe to just check that you can reproduce the same html output from running Doxygen 1.8.17 with the Doxygen config file in the base Moltres directory. And we can check the documentation for each individual kernel as we work on Issue #133 in the near future. @katyhuff would you agree?

@katyhuff
Copy link
Member

katyhuff commented Jan 29, 2021 via email

@smpark7
Copy link
Collaborator Author

smpark7 commented Jan 29, 2021

I pushed a commit to trigger a new round of CIVET tests. This round of tests has already passed the "Clean machine" Precheck checkpoint where we encountered the previous failure, so it looks good so far.

@smpark7 smpark7 self-assigned this Jan 29, 2021
@katyhuff
Copy link
Member

katyhuff commented Feb 1, 2021 via email

@smpark7
Copy link
Collaborator Author

smpark7 commented Feb 3, 2021

I agree that it is a ton of files and probably not in the right branch. We could set up a gh-pages branch that automatically compiles the docs every time there's a change.

The alternative would be perhaps hosting the files on the arfc.github.io repo

@katyhuff
Copy link
Member

katyhuff commented Feb 4, 2021

Created issue #149 to handle the question of which branch this belongs in.

@katyhuff katyhuff merged commit d437939 into arfc:devel Feb 4, 2021
@smpark7 smpark7 deleted the update-doc branch July 9, 2021 00:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Doxygen documentation
3 participants