ONSdigital / SDG_11.2.1

Analysis for the UN Sustainable Development Goal 11.2.1
https://onsdigital.github.io/SDG_11.2.1/
Apache License 2.0
5 stars 7 forks source link

Generate docstring documentation using mkdocstrings #397

Closed jwestw closed 1 year ago

jwestw commented 1 year ago

We need to create technical documentation, automatically generated by mkdocstrings as it was by Spinx.

The pages should be generated under the DEVELOPER GUIDANCE section, under the title "Technical Documentation"

jwestw commented 1 year ago

I have created a branch for this (linked) and work is going well. I have created pages for most of the modules, but not the nested ones (e.g. src/time_table/SDG....) the auto docs generator doesn't pick up on the code I am using in the md file, like:

::: src.time_table.SDG_train_timetable

Here is the geospatial mods page open

geospatial_mods autogenerated docs

I will push WIP