ecmwf/cfgrib.jl

Complete Documentation

Opened this issue · 0 comments

RobertRosca commented

Documentation infrastructure added by PR #7 and merged to dev.

First steps:

  • Set up working documentation build pipeline
  • Use GitHub Actions to run pipeline
  • Deploy to gh-pages branch to build a GitHub Page for the docs

Need to add in:

  • Better index page
    • Currently docs index and readme are the same, this should probably change
  • Introduction
  • Tutorials (probably ipynb converted to md via Documenter.jl or Literate.jl)

Docstrings:

  • backends
    • backend - AxisArrays
    • backend - DimensionalData
  • cfmessage
  • constants - (fix formatting)
  • dataset
  • indexing

Misc:

  • Fix doctests