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

Small edits to tutorial documentation. #441

Merged
merged 2 commits into from
Oct 11, 2021

Conversation

mgjarrett
Copy link
Contributor

I noticed a couple of small things that could/should be changed when scanning through the tutorial documentation recently. I think these are too small to warrant a formal issue, but it is still worth making the changes.

@john-science
Copy link
Member

First off, don't worry about an issue for something like this. Our PRs represent a good traceable record, as do our commits.

And thanks so much for the cleanup!

I haven't tried to build your change yet, but one thing pops out at me. I'm not certain, but could we change this:

[Building input files for a fast reactor](https://terrapower.github.io/armi/tutorials/walkthrough_inputs.html)

to this?

[Building input files for a fast reactor](walkthrough_inputs.html)

I am just thinking the relative path would be safer in case someone builds and deploys the documentation locally for testing.

@mgjarrett
Copy link
Contributor Author

Looks good to me. I initially attempted to link to the page using a reference in Sphinx but it wasn't working, so I just went with a URL. I didn't know this type of relative path would work, but I'm all for it.

@john-science
Copy link
Member

Looks good to me. I initially attempted to link to the page using a reference in Sphinx but it wasn't working, so I just went with a URL. I didn't know this type of relative path would work, but I'm all for it.

Sorry, just to be clear: I haven't actually tried it, I just assume it works. Have you tried making the docs yourself?

tox -e doc

@mgjarrett
Copy link
Contributor Author

I did try myself to confirm it would work before pushing. I didn't try tox -e doc, but it did work with make html. I'll try tox now, but it should work.

@john-science john-science self-requested a review October 11, 2021 22:38
@john-science john-science added the documentation Improvements or additions to documentation label Oct 11, 2021
Copy link
Member

@john-science john-science left a comment

Choose a reason for hiding this comment

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

Looks great!

Sorry for the hassle, it'll be smoother next time.

I just love having help with all these docs!

@john-science john-science merged commit a318531 into terrapower:master Oct 11, 2021
@john-science
Copy link
Member

Merged!

Thanks @mgjarrett !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants