From b6929afcdc4bc0b0aa0e0113e6b3ead629744080 Mon Sep 17 00:00:00 2001 From: Zachary Smith <22395357+Cutwell@users.noreply.github.com> Date: Wed, 23 Aug 2023 12:00:34 +0100 Subject: [PATCH] Updated docs formatting --- README.md | 2 +- docs/_config.yaml | 8 ++++---- docs/_pages/config.md | 3 +++ docs/_pages/index.md | 2 ++ 4 files changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 76c8235..ebe858f 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/_config.yaml b/docs/_config.yaml index e14aac8..eb6e2b1 100644 --- a/docs/_config.yaml +++ b/docs/_config.yaml @@ -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: diff --git a/docs/_pages/config.md b/docs/_pages/config.md index 5fbff2d..69c88ca 100644 --- a/docs/_pages/config.md +++ b/docs/_pages/config.md @@ -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.| @@ -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.| @@ -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.| diff --git a/docs/_pages/index.md b/docs/_pages/index.md index 163d009..d39d0a6 100644 --- a/docs/_pages/index.md +++ b/docs/_pages/index.md @@ -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