NRLMMD-GEOIPS / geoips

Main Geolocated Information Processing System code base with basic functionality enabled.
https://nrlmmd-geoips.github.io/geoips/
Other
14 stars 11 forks source link

507 documentation for developer assisted package creation #509

Open evrose54 opened 5 months ago

evrose54 commented 5 months ago

Reviewer Checklist

Related Issues

fixes NRLMMD-GEOIPS/geoips#507

Testing Instructions

Run ./docs/build_docs . geoips html_only. Documentation will build without any errors.

Summary

The aforementioned issue illustrates the need for a guideline which documents why, when, and how developers should work alongside users and researchers to get their geospatial data processing routines integrated alongside GeoIPS. Namely, here at CIRA, this is a large task for GeoIPS developers. We are expected to work alongside researchers to get their routines integrated alongside GeoIPS, and having this documentation layed out should streamline this process.

The created guideline illustrates why we do this, what use cases we'll support, and what information we as developers will need to generate a standalone package containing the researchers' geospatial data processing routines into a GeoIPS Package.

modified: docs/source/devguide/index.rst
modified: docs/source/releases/v1_12_2a0.rst
modified: docs/source/releases/v1_13_0a0.rst
added: docs/source/devguide/dev_assisted_package_creation.rst

(Change to v1_12_2a0.rst was needed as the documentation wouldn't build unless there was a blank line after a list)

Output

You can download geoips/build/sphinx/html directory and drag index.html into your browser to see the new documentation page.