dtcenter / METcalcpy

https://metcalcpy.readthedocs.io/en/latest/index.html
Apache License 2.0
16 stars 2 forks source link

Modify Python Requirements section of the User's Guide #352

Closed jprestop closed 7 months ago

jprestop commented 7 months ago

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.