Skip to content

Commit

Permalink
Updated docs formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
Cutwell committed Aug 23, 2023
1 parent 0113ca6 commit b6929af
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![PyPI](https://img.shields.io/pypi/v/python-web-io?style=flat-square)](https://pypi.org/project/python-web-io/)

## Documentation
Check out the [wiki](https://cutwell.github.io/python-web-io/docs/).
Check out the [wiki](https://cutwell.github.io/python-web-io/).

## License
MIT
8 changes: 4 additions & 4 deletions docs/_config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -132,12 +132,12 @@ footer:
- label: "Twitter"
icon: "fab fa-fw fa-twitter-square"
# url:
- label: "Facebook"
icon: "fab fa-fw fa-facebook-square"
# url:
- label: "PyPI"
icon: "fab fa-fw fa-python"
url: https://pypi.org/project/python-web-io/
- label: "GitHub"
icon: "fab fa-fw fa-github"
# url:
url: https://github.com/Cutwell/python-web-io
- label: "GitLab"
icon: "fab fa-fw fa-gitlab"
# url:
Expand Down
3 changes: 3 additions & 0 deletions docs/_pages/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ poetry run python_web_io --script="app.py" --config=".pythonwebio/config.toml" -
### `[about]`

These options populate the `About` modal, accessible from the page footer.

|||
|:---:|:---|
|`author`|Author's name / online alias.|
Expand All @@ -99,6 +100,7 @@ These options populate the `About` modal, accessible from the page footer.
### `[project]`

These options populate the `Help` modal, accessible from the page footer.

|||
|:---:|:---|
|`homepage`|A link to the project homepage, for instance on GitHub.|
Expand All @@ -108,6 +110,7 @@ These options populate the `Help` modal, accessible from the page footer.
### `[server]`

These options are for the underlying FastAPI server:

|||
|:---:|:---|
|`debug`|Boolean to enable debug mode.|
2 changes: 2 additions & 0 deletions docs/_pages/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
permalink: /
---

[![Static Badge](https://img.shields.io/badge/-Cutwell%2FPython_Web_IO-white?logo=github&logoColor=white&labelColor=black&color=white&link=https%3A%2F%2Fgithub.com%2FCutwell%2Fpython-web-io)](https://github.com/Cutwell/python-web-io) [![PyPI](https://img.shields.io/pypi/v/python-web-io?style=flat-square)](https://pypi.org/project/python-web-io/)

Welcome to the Python web I/O docs.

## License
Expand Down

0 comments on commit b6929af

Please sign in to comment.