Skip to content

Commit feb728d

Browse files
committed
added titles
1 parent 4245c70 commit feb728d

File tree

7 files changed

+13
-4
lines changed

7 files changed

+13
-4
lines changed

docs/_pages/cache.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ permalink: /docs/cache/
33
toc: true
44
---
55

6+
# Caching expensive operations
7+
68
`python-web-io` works by re-evaluating the target script after each user interaction, to progress the script to the next `input()`, etc.
79
This means expensive functions may be called more than once per session.
810
To reduce latency, a cache decorator is made available through the `python_web_io` module.

docs/_pages/config.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ permalink: /docs/config/
33
toc: true
44
---
55

6+
# Configuration and settings
7+
68
The appearance of generated pages are customisable via a `config.toml` file.
79
Create a subdirectory `/.pythonwebio` relative to were the project will be called from, and create a `config.toml` file inside.
810
```

docs/_pages/index.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,7 @@ permalink: /
33
layout: home
44
---
55

6-
[![PyPI](https://img.shields.io/pypi/v/python-web-io?style=flat-square)](https://pypi.org/project/python-web-io/)
7-
8-
## Documentation
9-
Check out the [wiki](https://github.com/Cutwell/python-web-io/wiki).
6+
Welcome to the Python web I/O docs.
107

118
## License
129
MIT

docs/_pages/installation.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ permalink: /docs/install/
33
toc: true
44
---
55

6+
# Installation
7+
68
Install `python-web-io` locally using:
79
```bash
810
pip install python-web-io

docs/_pages/io.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ input("Enter your telephone number", type='tel', attrs={'pattern': "[0-9]{3}-[0-
7474
<input type='tel' pattern=[0-9]{3}-[0-9]{2}-[0-9]{3}>
7575
```
7676

77+
# I/O overrides
78+
7779
For input types such as `button`, `radio` and `checkbox`, multiple inputs can be rendered at once. This is an optional argument for all inputs, but will only have an effect for these listed input types.
7880

7981
`button` and `radio` inputs can return a single option, or `None`, e.g.:

docs/_pages/quickstart.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ permalink: /docs/quickstart/
33
toc: true
44
---
55

6+
# Quickstart guide
7+
68
After installing the project, some environment setup is required:
79

810
## Required setup

docs/_pages/static.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ permalink: /docs/static/
33
toc: true
44
---
55

6+
# Serving static files
7+
68
If you wish to serve local files, such as custom `.css` stylesheets or images, they will need to be placed in the `./static` folder, relative to the project root.
79

810
```

0 commit comments

Comments
 (0)