FAQ | This is a LIVE service | Changelog

Skip to content
Snippets Groups Projects
  • Dr Rich Wareham's avatar
    17e6c7dd
    feat: add some basic documentation · 17e6c7dd
    Dr Rich Wareham authored
    The common CI pipeline has support for mkdocs-based documentation and so
    add a basic generated mkdocs config. Base the mkdocs config on the
    config which is likely to land in the copier template to minimise future
    disruption.
    
    We need to override some parts of the standard jobs to "inject" the
    documentation generated by the OpenAPI templates into them. We also need
    to add "fake" index.html files which take the place of the real
    documentation which will be injected in.
    17e6c7dd
    History
    feat: add some basic documentation
    Dr Rich Wareham authored
    The common CI pipeline has support for mkdocs-based documentation and so
    add a basic generated mkdocs config. Base the mkdocs config on the
    config which is likely to land in the copier template to minimise future
    disruption.
    
    We need to override some parts of the standard jobs to "inject" the
    documentation generated by the OpenAPI templates into them. We also need
    to add "fake" index.html files which take the place of the real
    documentation which will be injected in.
Code owners