[mapserver-dev] MS RFC 132: Update MapScript API Docs ready for review
Seth G
sethg at geographika.co.uk
Mon May 24 06:38:31 PDT 2021
Hi all,
I'm pleased to announce that the MapScript documentation generation, described in RFC132 [1] is now added to a pull request [2] ready for review.
Features include:
* Automatic stub generation based on the latest MapScript release. Keywords and functions.
* Any undocumented properties or functions has a TODO label added. The docs will always be up to date with the latest Python MapScript release
* Linking to Mapfile keywords to avoid duplication of docs (see Sphinx pull request)
* Linking to classes and functions available throughout docs, e.g. in HowTo and in the API docs themselves.
* Support for Python snippets from the Python test cases, ensuring examples continue to work with the latest codebase
* Set of Python scripts to update the list of available classes, constants, and enumerations, as well as class diagrams. These could also be set these to run automatically as part of the CI / docs build process
* Updates to the various MapScript HOWTO guides
Seth
[1] https://mapserver.org/id/development/rfc/ms-rfc-132.html
[2] https://github.com/MapServer/MapServer-documentation/pull/544
--
web:http://geographika.co.uk
twitter: @geographika
More information about the mapserver-dev
mailing list