Skip to content

Publish documentation on readthedocs #37

@nicoddemus

Description

@nicoddemus
  • Extract documentation from docstrings and publish on readthedocs;
  • Add proper install and usage instructions;
  • Craft a minimal complete example of the usage;
  • Fix documentation build;
  • Check and update examples;
  • Investigate a better layout for the "reference" section;
  • Improve in auto generated documentation;
  • Extent example list with ... (we should list more advanced features and create a item for each one);

Suggestion for new items are welcome.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions