fixed docs

2020-04-08 21:02:41 +02:00 · 2020-04-08 21:02:41 +02:00 · 1584c44113
parent 95905f5045
commit 1584c44113
10 changed files with 57 additions and 1 deletions
--- a/.gitignore
+++ b/.gitignore
@ -131,4 +131,3 @@ dmypy.json
 #Pycharm
 .idea/
 *.iml
-docs/source/
--- a/README.rst
+++ b/README.rst
@ -0,0 +1,7 @@
+============
+P2P Producer
+============
+
+Produced by GoldenPogácsa Inc.
+
+TODO
--- a/docs/index.rst
+++ b/docs/index.rst
@ -10,6 +10,8 @@ Welcome to Producer's documentation!
   :maxdepth: 2
   :caption: Contents:

+   readme
+   source/modules


 Indices and tables
--- a/docs/readme.rst
+++ b/docs/readme.rst
@ -0,0 +1,2 @@
+.. include:: ../README.rst
+
--- a/docs/source/app.rst
+++ b/docs/source/app.rst
@ -0,0 +1,7 @@
+app module
+==========
+
+.. automodule:: app
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/docs/source/communicator.rst
+++ b/docs/source/communicator.rst
@ -0,0 +1,7 @@
+communicator module
+===================
+
+.. automodule:: communicator
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/docs/source/consumerlocator.rst
+++ b/docs/source/consumerlocator.rst
@ -0,0 +1,7 @@
+consumerlocator module
+======================
+
+.. automodule:: consumerlocator
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/docs/source/messagesender.rst
+++ b/docs/source/messagesender.rst
@ -0,0 +1,7 @@
+messagesender module
+====================
+
+.. automodule:: messagesender
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/docs/source/modules.rst
+++ b/docs/source/modules.rst
@ -0,0 +1,11 @@
+producer
+========
+
+.. toctree::
+   :maxdepth: 4
+
+   app
+   communicator
+   consumerlocator
+   messagesender
+   test
--- a/docs/source/test.rst
+++ b/docs/source/test.rst
@ -0,0 +1,7 @@
+test module
+===========
+
+.. automodule:: test
+   :members:
+   :undoc-members:
+   :show-inheritance: