GFDRR / rdl-standard

The Risk Data Library Standard (RDLS) is an open data standard to make it easier to work with disaster and climate risk data. It provides a common description of the data used and produced in risk assessments, including hazard, exposure, vulnerability, and modelled loss, or impact, data.
https://docs.riskdatalibrary.org/
Creative Commons Attribution Share Alike 4.0 International
13 stars 1 forks source link

[Docs update] Fix codelists horizontal & vertical scroll, check hyperlinks #161

Closed odscjen closed 1 year ago

odscjen commented 1 year ago

Check if there is a way to present the open codelists without having to horizontally scroll

matamadio commented 1 year ago

Please also consider introducing height limitation for huge tables such as media formats - with an internal scroll, or collapsible. Also note in the schema reference (and possibly elsewhere) that the links to codelists #anchors with underscore should replace with dash:

E.g. https://rdl-standard.readthedocs.io/en/178-diagrams/reference/codelists/#function_approach does not work; it is https://rdl-standard.readthedocs.io/en/178-diagrams/reference/codelists/#function-approach

Best thing would be to have the hyperlink target to use underscore, to avoid confusion (since the schema codelists adopt underscore).

duncandewhurst commented 1 year ago

All sounds good. I'll make those updates as part of https://github.com/GFDRR/rdl-standard/pull/214

duncandewhurst commented 1 year ago

Best thing would be to have the hyperlink target to use underscore, to avoid confusion (since the schema codelists adopt underscore).

That isn't possible because Sphinx replaces the _ character in hyperlink targets with - for compatibility with CSS. As such, I've updated the codelist URLs in the schema to use - in https://github.com/GFDRR/rdl-standard/pull/236.

There shouldn't be any other broken links because Sphinx checks for unresolvable references in Markdown content and we've updated the Sphinx directive that generates the schema tables to do the same replacements as Sphinx in https://github.com/OpenDataServices/sphinxcontrib-opendataservices-jsonschema/pull/51, but let me know if you find any.

odscjen commented 1 year ago

closing as incorporated into https://github.com/GFDRR/rdl-standard/pull/236 and #214