Code

MkDocs Documentation#1

Code

Merged

mykolaskrynnyk merged 16 commits intomainUNDP-Data/st-undp:mainfrom mkdocs_documentationUNDP-Data/st-undp:mkdocs_documentationCopy head branch name to clipboardSep 21, 2024

Commits

Commits on Sep 20, 2024

• Build: add packages for creating project documentation in MkDocs

  mykolaskrynnyk

  committed
  769bddd

  Copy full SHA for 769bddd

• Docs: update the wording of the one-line package description

  mykolaskrynnyk

  committed
  ba1856f

  Copy full SHA for ba1856f

• Docs(mkdocs): create a basic website configuration

  mykolaskrynnyk

  committed
  df997a2

  Copy full SHA for df997a2

• Docs(mkdocs): add repo URLs, icons, copyright etc

  mykolaskrynnyk

  committed
  b4df090

  Copy full SHA for b4df090

• Docs(mkdocs): enable mkdocstrings plugin with NumPy-style support

  mykolaskrynnyk

  committed
  a9346cd

  Copy full SHA for a9346cd

• Docs(mkdocs): arrange sections in logical groups in mkdocs.yml

  mykolaskrynnyk

  committed
  bd22b01

  Copy full SHA for bd22b01

• Docs(mkdocs): separate installation and use into stand-alone pages

  mykolaskrynnyk

  committed
  de38823

  Copy full SHA for de38823

• Docs(mkdocs): enable code content copy

  mykolaskrynnyk

  committed
  61d0889

  Copy full SHA for 61d0889

• Docs(mkdocs): add a markdown extension to highlight code blocks

  mykolaskrynnyk

  committed
  9510bec

  Copy full SHA for 9510bec

Commits on Sep 21, 2024

• Docs(reference): add a reference page for public package functions

  mykolaskrynnyk

  committed
  d13a63c

  Copy full SHA for d13a63c

• Docs(usage): add recommended and advanced sections

  mykolaskrynnyk

  committed
  3a23b45

  Copy full SHA for 3a23b45

• Docs(readme): update basic usage in line with the documentation

  mykolaskrynnyk

  committed
  e89e59e

  Copy full SHA for e89e59e

• Docs(components): add module and function docstrings

  mykolaskrynnyk

  committed
  cf0dd1a

  Copy full SHA for cf0dd1a

• Docs(preview): add a gif preview and a link to the app

  mykolaskrynnyk

  committed
  bb70d40

  Copy full SHA for bb70d40

• Style(docs): add custom styles for mkdocs

  mykolaskrynnyk

  committed
  59261a4

  Copy full SHA for 59261a4

• Style(preview): add a border around the preview image

  mykolaskrynnyk

  committed
  d6e6a37

  Copy full SHA for d6e6a37