search

idaholab / TMAP8

Tritium Migration Analysis Program, Version 8
https://mooseframework.inl.gov/TMAP8/
GNU Lesser General Public License v2.1
15 stars 18 forks source link

Create documentation for `PhysicalConstants`. #92

Closed simopier closed 7 months ago

simopier commented 7 months ago

(Close. #91)

moosebuild commented 7 months ago

Job Documentation on 46a0fcb wanted to post the following:

View the site here

This comment will be updated on new commits.

simopier commented 7 months ago

I have a questions for you, @cticenhour. I'm trying to add documentation for PhysicalConstants.h, which sits in utils, and I cannot find it when I create the documentation.

it is possible to find it when typing https://mooseframework.inl.gov/tmap8/docs/PRs/92/site/source/utils/PhysicalConstants.html, but it's not listed in the complete code syntax.

I'm clearly missing something to include it to the syntax, but I cannot figure out what.

EDIT: the new bib file is also giving me trouble, I am not sure how to tackle this.

cticenhour commented 7 months ago

PhysicalConstants is not a registered MOOSE object. So it won't show up in syntax, and you'll have to create a link on one of the other documentation pages.

simopier commented 7 months ago

PhysicalConstants is not a registered MOOSE object. So it won't show up in syntax, and you'll have to create a link on one of the other documentation pages.

How can I register a namespace?

cticenhour commented 7 months ago

How can I register a namespace?

We do not register namespaces, only MOOSE objects for input files, underlying actions, and systems. I would say the best place to put this is in the heading content at the top of the syntax markdown file. I can explore fixes for this and push a change to this effect for your review.

cticenhour commented 7 months ago

@simopier Submitted two commits that I am considering part of the "review suggestions" portion of this, just committed pre-emptively. d1649f2 gets the documentation building - the file needed to be moved within the content directory, and I made a suggestion on a name change for it. 46a0fcb is a suggestion related to how to show the documentation link on both syntax pages.

If you want to make further changes to it (or remove the latter commit altogether), feel free. I can also make modifications, or remove commits entirely.

simopier commented 7 months ago

@cticenhour , thank you very much! That looks perfect to me!

cticenhour commented 7 months ago

Taking that as approval of my commits, and I formally approve the rest of the changes!