docs : Add sphinx for handling documentation
Edit gitignore by ignoring the docs/build directory Add sphinx dependencies to pyproject Add docs folder
This commit is contained in:
77
docs/source/unisync.rst
Normal file
77
docs/source/unisync.rst
Normal file
@@ -0,0 +1,77 @@
|
||||
unisync package
|
||||
===============
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
unisync.argparser module
|
||||
------------------------
|
||||
|
||||
.. automodule:: unisync.argparser
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
unisync.config module
|
||||
---------------------
|
||||
|
||||
.. automodule:: unisync.config
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
unisync.defaults module
|
||||
-----------------------
|
||||
|
||||
.. automodule:: unisync.defaults
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
unisync.errors module
|
||||
---------------------
|
||||
|
||||
.. automodule:: unisync.errors
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
unisync.main module
|
||||
-------------------
|
||||
|
||||
.. automodule:: unisync.main
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
unisync.paths module
|
||||
--------------------
|
||||
|
||||
.. automodule:: unisync.paths
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
unisync.runners module
|
||||
----------------------
|
||||
|
||||
.. automodule:: unisync.runners
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
unisync.synchroniser module
|
||||
---------------------------
|
||||
|
||||
.. automodule:: unisync.synchroniser
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: unisync
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
Reference in New Issue
Block a user