geopython / pygeoapi

pygeoapi is a Python server implementation of the OGC API suite of standards. The project emerged as part of the next generation OGC API efforts in 2018 and provides the capability for organizations to deploy a RESTful OGC API endpoint using OpenAPI, GeoJSON, and HTML. pygeoapi is open source and released under an MIT license.

https://pygeoapi.io

MIT License

490 stars 260 forks source link

clean up API docs, move plugins to wiki #1572

Closed tomkralidis closed 7 months ago

tomkralidis commented 7 months ago

Overview

cleans up API documentation (Sphinx autodoc) to contain base class documentation
turns on strict checking (warnings as errors) as part of HTML building
fixes resulting warnings
moves example plugins section to wiki page and references
Related issue / discussion

None

Additional information

This PR should only be merged once #1571 is clarified/merged (cc @doublebyte1)

Dependency policy (RFC2)

[x] I have ensured that this PR meets RFC2 requirements

Updates to public demo

[x] I have ensured that breaking changes to the pygeoapi master demo server have been addressed
- [ ] https://github.com/geopython/demo.pygeoapi.io/blob/master/services/pygeoapi_master/local.config.yml

Contributions and licensing

(as per https://github.com/geopython/pygeoapi/blob/master/CONTRIBUTING.md#contributions-and-licensing)

[x] I'd like to contribute [feature X|bugfix Y|docs|something else] to pygeoapi. I confirm that my contributions to pygeoapi will be compatible with the pygeoapi license guidelines at the time of contribution
[x] I have already previously agreed to the pygeoapi Contributions and Licensing Guidelines