Skip to content

Documentation improvements #88

Description

@IgnacioJPickering

The following would improve the bblean docs:

  • Usable "user guide" with jupyter notebooks (using nbsphinx probably) right now it is a placeholder
  • Document the CLI
  • Improve all docstrings and use a docstring style consistently throughout
  • Deploy a "stable" version of the docs to gh pages, on published releases
  • Fix issue with SCM version not being correctly added to the docs
  • add min python version
  • add swap info on linux

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions