diff --git a/.gitignore b/.gitignore index 2e41a8c..cf3c132 100644 --- a/.gitignore +++ b/.gitignore @@ -131,4 +131,3 @@ dmypy.json #Pycharm .idea/ *.iml -docs/source/ diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..bd2e049 --- /dev/null +++ b/README.rst @@ -0,0 +1,7 @@ +============ +P2P Producer +============ + +Produced by GoldenPogácsa Inc. + +TODO diff --git a/docs/index.rst b/docs/index.rst index 3e07bd5..113ed40 100644 --- 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 diff --git a/docs/readme.rst b/docs/readme.rst new file mode 100644 index 0000000..0aa732a --- /dev/null +++ b/docs/readme.rst @@ -0,0 +1,2 @@ +.. include:: ../README.rst + diff --git a/docs/source/app.rst b/docs/source/app.rst new file mode 100644 index 0000000..ceb7f40 --- /dev/null +++ b/docs/source/app.rst @@ -0,0 +1,7 @@ +app module +========== + +.. automodule:: app + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/communicator.rst b/docs/source/communicator.rst new file mode 100644 index 0000000..fa3722a --- /dev/null +++ b/docs/source/communicator.rst @@ -0,0 +1,7 @@ +communicator module +=================== + +.. automodule:: communicator + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/consumerlocator.rst b/docs/source/consumerlocator.rst new file mode 100644 index 0000000..19c3c0b --- /dev/null +++ b/docs/source/consumerlocator.rst @@ -0,0 +1,7 @@ +consumerlocator module +====================== + +.. automodule:: consumerlocator + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/messagesender.rst b/docs/source/messagesender.rst new file mode 100644 index 0000000..6c4fce9 --- /dev/null +++ b/docs/source/messagesender.rst @@ -0,0 +1,7 @@ +messagesender module +==================== + +.. automodule:: messagesender + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 0000000..36a6778 --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,11 @@ +producer +======== + +.. toctree:: + :maxdepth: 4 + + app + communicator + consumerlocator + messagesender + test diff --git a/docs/source/test.rst b/docs/source/test.rst new file mode 100644 index 0000000..206500f --- /dev/null +++ b/docs/source/test.rst @@ -0,0 +1,7 @@ +test module +=========== + +.. automodule:: test + :members: + :undoc-members: + :show-inheritance: