Skip to content

Write basic docsΒ #3

@thoward

Description

@thoward

Include, at minimum:

  • some usage examples
  • a description of what RST features are covered, and what the expected output will be (e.g. what kind of tag, and what CSS class)
  • a description of what RST features are NOT covered, and how those are output/handled
  • explain the relationship to the parser project, and which things are handled by parser, but not by renderer, vs things just not handled by parser at all
  • add a "contributing" section, including basic dev docs on how to make changes, run tests, publish new version of the package, etc.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions