Merge pull request #10 from imubit/fix-docs-generation

add docs generation

CONTRIBUTING.md

@@ -367,5 +367,5 @@ on [PyPI], the following steps can be used to release a new version for
 ```{todo} Please review and change the following definitions:
 ```
 
-[repository]: https://github.com/<USERNAME>/amqp-fabric
-[issue tracker]: https://github.com/<USERNAME>/amqp-fabric/issues
+[repository]: https://github.com/imubit/amqp-fabric
+[issue tracker]: https://github.com/imubit/amqp-fabric/issues

README.md

@@ -1,18 +1,19 @@
-[![Built Status](https://api.cirrus-ci.com/github/imubit/amqp-fabric.svg?branch=main)](https://cirrus-ci.com/github/imubit/amqp-fabric)
 [![PyPI-Server](https://img.shields.io/pypi/v/amqp-fabric.svg)](https://pypi.org/project/amqp-fabric/)
 [![Coveralls](https://img.shields.io/coveralls/github/imubit/amqp-fabric/main.svg)](https://coveralls.io/r/imubit/amqp-fabric)
+[![Wheel](https://img.shields.io/pypi/wheel/amqp-fabric.svg)](https://pypi.python.org/pypi/amqp-fabric/)
+[![PyVersions](https://img.shields.io/pypi/pyversions/amqp-fabric.svg)](https://pypi.python.org/pypi/amqp-fabric/)
 
 # amqp-fabric
 
-AMQP Fabric is an AMQP based microservice orchestration and communication framework.
+AMQP Fabric is an AMQP based "one-stop-shop" microservice orchestration and communication framework.
 
 ## Description
 
 AMQP Fabric is a very simple microservice communication and orchestration mechanism based on AMQ protocol. Instead of
 relying on multiple technologies and orchestration frameworks - it's a "one-stop shop" library for implementing a
 light-weight microservices topology.
 
-Each service in the ecosystem can publish it's own API and use API of another service. A service can send an
+Each service in the ecosystem can publish its own API and use API of another service. A service can send an
 asynchronous stream of data that other services can subscribe to.
 Services can optionally send periodic "keep-alives" to allow tracking its uptime.
 

docs/index.md

@@ -3,17 +3,6 @@
 Package connecting different microservices
 
 
-## Note
-
-> This is the main page of your project's [Sphinx] documentation. It is
-> formatted in [Markdown]. Add additional pages by creating md-files in
-> `docs` or rst-files (formatted in [reStructuredText]) and adding links to
-> them in the `Contents` section below.
->
-> Please check [Sphinx] and [MyST] for more information
-> about how to document your project and how to configure your preferences.
-
-
 ## Contents
 
 ```{toctree}