papyri
{ } Raw JSON

bundles / papyri latest / docs

Doc

Papyri

docs/index

Welcome to Papyri narrative docs.

This show that papyri can support narrative docs as well as API docs, though for the time being API docs are better supported.

If you find issues feel free to open an issue on GitHub.

If you are working only on API docs, you can use papyri gen <conffile.toml> --no-api, to skip the API generation part. Though be aware that some of the cross linking features will not work.

Examples

These are examples of various RST constructs, mostly as a visual test they render correctly (or not yet).

Lists

Enumerated lists

  • item 1

  • item 2

  • item 3

Bullet Lists

  • Item

  • other item

  • another one

Headers

Header 3

Header 4

Header 5

Directives

Note that directive are not a thing in themselves, and convert to other kind of nodes, when they are not understood they are currently rendered raw, but will be an error

Code block (to be done)

This will be math