-
Notifications
You must be signed in to change notification settings - Fork 9
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
Add references to MCNP Manual in docstrings for Input classes #413
Comments
So 1. I didn't know about MCNP4C and MCNPX being publicly available. As of right now we do support 6.2 and 6.3 exclusively officially. The 6.3 manual was moved all about so the section numbers are different. I want to add the 6.3 manual for sure. I'm not sure how I feel about 6.2. Some food for thought:
This could then be rendered as: Further reading:
|
Supporting only the latest would be cleanest. It would be the same amount of work to maintain this for only the latest release or all supported releases starting at 6.2. Hyperlinking: I don't know how reliable this is, but you could do it. Here is an example based on a section I was just looking at. Obviously, the PDF link should be a variable so that it can be readily updated if the LANL website moves the PDFs again. |
FTFY |
I feel like we should split this into two tasks: build the machinery, and then populate the fields. I don't think building the machinery in sphinx would be necessarily a good first issue. |
I'm wondering if there's an existing sphinx package that could be hacked to do this. |
Yes! We can also use that to link to issues from the changelog, etc! |
The machinery is pretty easy, but then again, I'm the |
related to #559. |
Is your feature request related to a problem? Please describe.
No
Describe the solution you'd like
For each publicly-available users manuals for versions of MCNP supported by MontePy, add a reference to the corresponding section of the user's manual where the input syntax is described. Right now, this is: MCNP4C, MCNPX, MCNP6.2, MCNP6.3
Describe alternatives you've considered
Additional context
A good first issue for a new developer to become familiar with MontePy data types and MCNP syntax.
The text was updated successfully, but these errors were encountered: