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
461 stars 251 forks source link

Fix bullet point nesting in docs #1709

Closed C-Loftus closed 1 week ago

C-Loftus commented 1 week ago

Overview

The nested lists on the main page of the documentation site (and a few other pages) are not rendering properly. The rst for nested bullet points is not using proper syntax of adding an extra newline before and after the nested level. Thus, the * are rendered inline. For an example see the bottom of the attached image. This commit just adds extra lines to make the docs render properly.

I referenced the rst syntax here.

Nested lists are possible, but be aware that they must be separated from the parent list items by blank lines:

This commit is relatively trivial but helps improve a11y and styling.

Dependency policy (RFC2) / Issues

N/A

Updates to public demo

N/A

Contributions and licensing

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

Before

image

After

image

C-Loftus commented 1 week ago

And of course if I am missing something here and this is a result of an autoformatter or something else in CI feel free to close

tomkralidis commented 1 week ago

Thanks @C-Loftus !