Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #796 +/- ##
=======================================
Coverage 84.12% 84.12%
=======================================
Files 71 71
Lines 4944 4944
=======================================
Hits 4159 4159
Misses 785 785
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
| - name: Code Checkout | ||
| uses: actions/checkout@v4 | ||
| - name: Make Sphinx Requirements | ||
| run: | | ||
| echo "sphinx" > requirements.txt | ||
| echo "sphinx_rtd_theme" >> requirements.txt | ||
| echo "sphinx_design" >> requirements.txt | ||
| echo "sphinx-sitemap" >> requirements.txt | ||
| echo "sphinxcontrib-mermaid" >> requirements.txt | ||
| echo "doc8" >> requirements.txt |
There was a problem hiding this comment.
you can stick these under pyproject.toml's optional-dependencies section for docs
There was a problem hiding this comment.
Okay - let me see: also, not sure I need to have all of thee sphinx's installed. Might just need our typical docs dependencies + doc8.
| - name: Install Python Requirements | ||
| run: | | ||
| pip install -r requirements.txt | ||
| pip install doc8 |
There was a problem hiding this comment.
same as above, and then do pip install .[docs]
i guess, as an alternative, we could put this requirements file in docs/
There was a problem hiding this comment.
Regardless of the method chosen (requirement.txt or pip install .[docs]), you will want to add documentation somewhere with the steps to set up the documentation build, and how to run the lint process.
Take a look at the RDHPCS CONTRIBUTING.md file.
There was a problem hiding this comment.
|
@ilaflott Qhat did you change in the last commit? I can't tell |
i updated your branch via |
|
Thanks! |
3 participants
Describe your changes
Issue ticket number and link (if applicable)
This PR fixes #810
Checklist before requesting a review
Note: If you are a code maintainer updating the tag or releasing a new fre-cli version, please use the
release_procedure.mdtemplate. To quickly use this template, open a new pull request, choose your branch, and add?template=release_procedure.mdto the end of the url.