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

Create Docs for scripts and standardize the docstrings #158

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

nsryan2
Copy link
Member

@nsryan2 nsryan2 commented Feb 20, 2024

This PR initializes sphinx autodocs for each of the scripts/*.py files. This PR also adds instructions on how to build the docs, and standardizes the docstrings. It also moves the gaps directory up to the top level out of the old docs folder. Closes #151, and would be good to have as part of #154.

Most of the changes are creating the files below, and removing colons from docstrings. A good check would be if you can build the docs themselves, they should still be pretty rough around the edges (we'll build on it in future PRs).

Autodoc files that correspond to a script.

  • docs/analysis_doc.rst
  • docs/create_ar_deployinst_doc.rst
  • docs/create_cyclus_input_doc.rst
  • docs/dakota_input_doc.rst
  • docs/dataframe_analysis_doc.rst
  • docs/index.rst
  • docs/merge_coordinates_doc.rst
  • docs/output_metrics_doc.rst
  • docs/predicting_the_past_import_doc.rst
  • docs/random_lifetime_extension_doc.rst
  • docs/scripts_outline.rst
  • docs/transition_metrics_doc.rst
  • docs/transition_plots_doc.rst

This PR does not:

  1. Add docs for the tests. Add Test Docs #161
  2. Document the other projects in the repository. Add narrative to the docs #159
  3. Include examples. Add docs examples #160
  4. Establish narrative on the existing docs. Add narrative to the docs #159
  5. Functionalize and document the create_cyclus_input.py script. Functionalize and document create_cyclus_input.py #162

@pep8speaks
Copy link
Contributor

pep8speaks commented Feb 20, 2024

Hello @nsryan2! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2024-02-23 15:33:59 UTC

@nsryan2 nsryan2 marked this pull request as ready for review February 23, 2024 15:51
@nsryan2 nsryan2 changed the title [DRAFT] Create Docs for scripts and standardize the docstrings Create Docs for scripts and standardize the docstrings Feb 23, 2024
@nsryan2 nsryan2 requested a review from ceserz2 February 23, 2024 15:55
@nsryan2 nsryan2 moved this from In progress to Needs review in Fuel Cycles Feb 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Fuel Cycles
  
Needs review
Development

Successfully merging this pull request may close these issues.

Initalize Narrative Docs
3 participants