papyri 0.0.8 Pypi GitHub

---

---

Papyri

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 and 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

1. item 1

2. item 2

3. 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

>>> This

.. currentmodule:: not handled
    

.. seealso:: not handled
    

.. highlight:: not handled
    

Code block (to be done)

This will be math

Examples

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them