docs #6

Merged
dscharnitzky merged 7 commits from docs into master 2020-04-08 23:05:32 +02:00
10 changed files with 57 additions and 1 deletions
Showing only changes of commit 1584c44113 - Show all commits

1
.gitignore vendored
View File

@ -131,4 +131,3 @@ dmypy.json
#Pycharm
.idea/
*.iml
docs/source/

7
README.rst Normal file
View File

@ -0,0 +1,7 @@
============
P2P Producer
============
Produced by GoldenPogácsa Inc.
TODO

View File

@ -10,6 +10,8 @@ Welcome to Producer's documentation!
:maxdepth: 2
:caption: Contents:
readme
source/modules
Indices and tables

2
docs/readme.rst Normal file
View File

@ -0,0 +1,2 @@
.. include:: ../README.rst

7
docs/source/app.rst Normal file
View File

@ -0,0 +1,7 @@
app module
==========
.. automodule:: app
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,7 @@
communicator module
===================
.. automodule:: communicator
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,7 @@
consumerlocator module
======================
.. automodule:: consumerlocator
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,7 @@
messagesender module
====================
.. automodule:: messagesender
:members:
:undoc-members:
:show-inheritance:

11
docs/source/modules.rst Normal file
View File

@ -0,0 +1,11 @@
producer
========
.. toctree::
:maxdepth: 4
app
communicator
consumerlocator
messagesender
test

7
docs/source/test.rst Normal file
View File

@ -0,0 +1,7 @@
test module
===========
.. automodule:: test
:members:
:undoc-members:
:show-inheritance: