-
Notifications
You must be signed in to change notification settings - Fork 41
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
Conversation
@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. |
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?
|
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 |
We definitely need the tests to pass.
…On Fri, Jan 29, 2021 at 3:43 AM Sun Myung Park ***@***.***> wrote:
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 <https://github.com/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
<#133> in the near future. @katyhuff
<https://github.com/katyhuff> would you agree?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#148 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AADAFK74E3AWFU2EVQHEMGDS4J7NXANCNFSM4WXLPFSA>
.
|
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. |
Excellent.
Now my only concern is that there tons of files. I have a couple of
questions:
1) Is this the right branch to submit these changes to? (with
documentation, it's common to have the source changes in one branch, with
the built files deployed in another branch. I forget how we did it here.)
2) Are all of these files definitely necessary to include in the repo?
(it's just a lot of them.)
…On Fri, Jan 29, 2021 at 7:49 AM Sun Myung Park ***@***.***> wrote:
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.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#148 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AADAFKZZ5ZI3LD4TKO2LNK3S4K4IBANCNFSM4WXLPFSA>
.
|
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 |
Created issue #149 to handle the question of which branch this belongs in. |
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
andDiffusionNoBCBC.h
.