Skip to content

Revamp documentation, use Documenter.jl to generate API docs #39

@dhanak

Description

@dhanak
  • revise docstrings to follow the general Julia documentation guidelines;
  • use Documenter.jl to generate full documentation;
  • add doctests to the docstrings where feasible;
  • extend CI pipeline to automatically generate and publish documentation to GitHub Pages.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationhelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions