work on docs

Signed-off-by: Grant Ramsay <[email protected]>

Author: seapagan

docs/usage.md

@@ -2,9 +2,9 @@
 
 ## Installation
 
-Clone the repository and install the dependencies. This project uses
-[Poetry][poetry]{:target="_blank"} for dependency management which should be
-installed on your system first.
+Clone the repository from [here][repo]{:target="_blank"} and install the
+dependencies. This project uses [Poetry][poetry]{:target="_blank"} for
+dependency management which should be installed on your system first.
 
 ```console
 poetry install
@@ -30,7 +30,8 @@ uvicorn main:app --reload
 > python main.py
 > ```
 
-Then open your browser at [http://localhost:8000](http://localhost:8000).
+Then open your browser at
+[http://localhost:8000](http://localhost:8000){:target="_blank"}.
 
 There is only one endpoint available: `/users`. It returns a list of all users
 for a `GET` request and creates a new user for a `POST` request.
@@ -83,3 +84,4 @@ DATABASE_URL = "sqlite+aiosqlite:///./test.db"
 [postgres]:https://www.postgresql.org/
 [docker]:https://www.docker.com/
 [sqlite]:https://www.sqlite.org/
+[repo]:https://github.com/seapagan/fastapi_async_sqlalchemy2_example

mkdocs.yml

@@ -3,6 +3,8 @@ site_name: Async SQLAlchemy 2 with FastAPI
 repo_url: https://github.com/seapagan/fastapi_async_sqlalchemy2_example
 repo_name: fastapi_async_sqlalchemy2
 
+dev_addr: "127.0.0.1:9000"
+
 theme:
   name: material
   features:
@@ -18,6 +20,8 @@ extra:
     - icon: fontawesome/brands/twitter
       link: https://twitter.com/gnramsay-dev
 
+copyright: © 2023-2024 Grant Ramsay (Seapagan)
+
 plugins:
   - search
   - minify:

pyproject.toml

@@ -57,6 +57,16 @@ ruff.cmd = "ruff check ."
 markdown.cmd = "pymarkdown --strict-config scan  -r docs/**/*.md"
 markdown.help = "Run markdown checks"
 
+# documentation tasks
+"docs:publish".cmd = "mkdocs gh-deploy"
+"docs:publish".help = "Publish documentation to GitHub Pages"
+"docs:build".cmd = "mkdocs build"
+"docs:build".help = "Build documentation locally to './site' folder"
+"docs:serve".cmd = "mkdocs serve"
+"docs:serve".help = "Serve documentation locally"
+"docs:serve:all".cmd = "mkdocs serve"
+"docs:serve:all".help = "Serve documentation locally on all interfaces"
+
 [tool.pymarkdown]
 plugins.md014.enabled = false
 plugins.md046.enabled = false