Describe the literal system requirements needed to run GeoIPS, including minimum and recommended specifications. The documentation should be information-oriented and reference-style, without including installation instructions, future potential requirements, or how GeoIPS works.
Notes about potential future system requirements (unless necessary)
Information on how GeoIPS works
Does include
Minimum system requirements
Recommended system requirements
Developer system requirements
Accurate and current information as of the latest GeoIPS installation
Links to related documentation sections for context
Draft Outline
# System Requirements
[intro, links to related content]
[table of system requirements]
Checklist for Completion
[ ] Work done on a feature branch, eg. documentation-adding-functionality
[ ] Write the required documentation in RST.
[ ] Add any required resource files to a sub-folder
[ ] Run ./docs/build_docs.sh to ensure the documentation builds correctly, inspect the result, and edit as required to achieve a well formatted document.
[ ] Update the relevant release notes.
[ ] Readable and followable writing, please use a grammar checker + spell checker
[ ] Passes doc8 checks, see the sphinx RST Primer and checkout this black-like tool @biosafetylvl5 wrote for auto-formatting RST files: pink
[ ] A PR from your feature branch to main 😊 with @biosafetylvl5 as a reviewer
Due on for review on: May 27th
Documentation Task
Files to be edited
Resources to be created
Related Documentation
Scope of Documentation
Draft Outline
Checklist for Completion
./docs/build_docs.sh
to ensure the documentation builds correctly, inspect the result, and edit as required to achieve a well formatted document.main
😊 with @biosafetylvl5 as a reviewer