Skip to content

Commit

Permalink
Add note about ascii
Browse files Browse the repository at this point in the history
  • Loading branch information
melissawm committed Oct 27, 2023
1 parent c112126 commit d9721b4
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ $ papyri gen examples/scipy.toml
This will create intermediate docs files in in `~/.papyri/data/<library name>_<library_version>`
### installation/ingestion
### Installation/ingestion
The installation/ingestion of documentation bundles is the step that makes all
bundles "aware" of each other, and allows crosslinking/indexing to work.
Expand Down Expand Up @@ -242,13 +242,19 @@ $ papyri serve-static # start a http.server with the propoer root to serve above
$ papyri serve # start a server that will render the pages on the fly (nice to debug or iterate on theme, rendering)
```
### Ascii terminal rendering
### Ascii terminal rendering (experimental)
```
$ papyri ascii <fully qualified names> # try to render in the terminal.
```
For example,
```
$ papyri ascii numpy.linspace
```
The next step uses urwid to provide a browsable interface in terminal.
```
Expand Down

0 comments on commit d9721b4

Please sign in to comment.