Skip to content

Commit d055cf4

Browse files
committed
Update the structure of the API docs into separate pages, one for each submodule. All to be autogenerated from the source files in ./pyscript.
1 parent 896ca84 commit d055cf4

30 files changed

Lines changed: 471 additions & 313 deletions

docs/api.md

Lines changed: 0 additions & 57 deletions
This file was deleted.

docs/api/context.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# `pyscript.context`
2+
3+
::: pyscript.context

docs/api/display.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# `pyscript.display`
2+
3+
::: pyscript.display

docs/api/events.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# `pyscript.event`
2+
3+
::: pyscript.events

docs/api/fetch.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# `pyscript.fetch`
2+
3+
::: pyscript.fetch

docs/api/ffi.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# `pyscript.ffi`
2+
3+
::: pyscript.ffi

docs/api/flatted.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# `pyscript.flatted`
2+
3+
::: pyscript.flatted

docs/api/fs.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# `pyscript.fs`
2+
3+
::: pyscript.fs

docs/api/init.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# The `pyscript` API
2+
3+
!!! important
4+
5+
These API docs are auto-generated from our source code. To suggest
6+
changes or report errors, please do so via
7+
[our GitHub repository](https://github.com/pyscript/pyscript). The
8+
source code for these APIs
9+
[is found here](https://github.com/pyscript/pyscript/tree/main/core/src/stdlib/pyscript)
10+
in our repository.
11+
12+
::: pyscript
13+
options:
14+
show_root_heading: false

docs/api/media.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# `pyscript.media`
2+
3+
::: pyscript.media

0 commit comments

Comments
 (0)