Modify Python Requirements section of the User's Guide #352
Labels
component: documentation
Documentation issue
priority: high
High Priority
requestor: METplus Team
METplus Development Team
type: task
An actionable item of work
Milestone
Describe the Task
Modify the Python Requirements section of the User's Guide so that the information is not listed directly, but rather so that there is use of a
literalinclude
linking to the requirements.txt file, which will automatically stay updated.As an example, refer to the METplus User's Guide. See this line in the PointStat.py which uses RST's
.. literalinclude::
and renders on the web in what appears to be a code block in this section.Also put a note at the top:
The requirements below come directly from the requirements.txt file at the top level of the repository.
Time Estimate
<1 day of work
Sub-Issues
Consider breaking the task down into sub-issues.
Relevant Deadlines
METcalcpy-3.0.0 release
Funding Source
Split across accounts (@lisagoodrich let me know if you have any questions)
2702691 JNT DTC NSF BASE FUN…
2784543 NOAA R2O METp SW2
2799991 Met Office METplus S…
Define the Metadata
Assignee
Labels
Projects and Milestone
Define Related Issue(s)
Consider the impact to the other METplus components.
Task Checklist
See the METplus Workflow for details.
Branch name:
feature_<Issue Number>_<Description>
Pull request:
feature <Issue Number> <Description>
Select: Reviewer(s) and Development issues
Select: Repository level development cycle Project for the next official release
Select: Milestone as the next official version
The text was updated successfully, but these errors were encountered: