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

Windows implementation to generate documentation #135

Merged
merged 1 commit into from
Feb 15, 2022

Conversation

dgarrett622
Copy link
Collaborator

@dgarrett622 dgarrett622 commented Feb 15, 2022


Pull Request Description

What issue does this change request address?

Closes #134

What are the significant changes in functionality due to this change request?

Dependencies on bash scripts are removed from the make_docs.bat file to generate documentation. The file make_docs.bat can be run by command from native Windows cmd or PowerShell (no need for git bash). The file make_docs.bat can also be run automatically by double clicking from the file explorer.


For Change Control Board: Change Request Review

The following review must be completed by an authorized member of the Change Control Board.

  • 1. Review all computer code.
  • 2. If any changes occur to the input syntax, there must be an accompanying change to the user manual and xsd schema. If the input syntax change deprecates existing input files, a conversion script needs to be added (see Conversion Scripts).
  • 3. Make sure the Python code and commenting standards are respected (camelBack, etc.) - See on the wiki for details.
  • 4. Automated Tests should pass.
  • 5. If significant functionality is added, there must be tests added to check this. Tests should cover all possible options. Multiple short tests are preferred over one large tes.
  • 6. If the change modifies or adds a requirement or a requirement based test case, the Change Control Board's Chair or designee also needs to approve the change. The requirements and the requirements test shall be in sync.
  • 7. The merge request must reference an issue. If the issue is closed, the issue close checklist shall be done.
  • 8. If an analytic test is changed/added, the the analytic documentation must be updated/added.
  • 9. If any test used as a basis for documentation examples have been changed, the associated documentation must be reviewed and assured the text matches the example.

@dgarrett622 dgarrett622 added the documentation Improvements or additions to documentation label Feb 15, 2022
@dgarrett622 dgarrett622 self-assigned this Feb 15, 2022
@PaulTalbot-INL PaulTalbot-INL merged commit b9043ae into idaholab:devel Feb 15, 2022
@dgarrett622 dgarrett622 deleted the batch_update branch March 22, 2022 15:13
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.

[DEFECT] Building documentation broken for Windows
2 participants