Polish Readme. #41

	# This workflow will check flake style
	# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

	name: Docs Deploy

	on:
	push:
	branches: [ main, 'doc/', 'dev/' ]
	release:
	types: [ published ]

	jobs:
	doc:
	runs-on: ubuntu-latest
	permissions:
	contents: write # Allows writing to the repository
	strategy:
	matrix:
	python-version: [ 3.9 ]

	services:
	plantuml:
	image: plantuml/plantuml-server
	ports:
	- 18080:8080

	steps:
	- uses: actions/checkout@v4
	- name: Set up Python ${{ matrix.python-version }}
	uses: actions/setup-python@v5
	with:
	python-version: ${{ matrix.python-version }}
	- name: Install dependencies
	run: \|
	sudo apt-get update -y
	sudo apt-get install -y make wget curl cloc graphviz
	dot -V
	python -m pip install -r requirements-doc.txt
	python -m pip install .
	- name: Generate
	env:
	ENV_PROD: 'true'
	PLANTUML_HOST: http://localhost:18080
	run: \|
	cd docs
	make html
	mv build/html ../public
	- name: Deploy to Github Page
	uses: JamesIves/github-pages-deploy-action@v4
	with:
	GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
	BRANCH: gh-pages # The branch the action should deploy to.
	FOLDER: public # The folder the action should deploy.
	CLEAN: true # Automatically remove deleted files from the deploy branch

Provide feedback