YunoHost/moulinette
1
0
Fork 0
mirror of https://github.com/YunoHost/moulinette.git synced 2024-09-03 20:06:31 +02:00
Code Issues Projects Releases Packages Wiki Activity

[doc] use autodoc to generate doc based on docstring

Browse source
This commit is contained in:
Laurent Peuch 2017-07-22 10:25:23 +02:00
parent 5cc36bb717
commit 997b2053be
5 changed files with 26 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/conf.py
View file

@ -15,10 +15,10 @@
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here. # documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os import os
# import sys import sys
# sys.path.insert(0, os.path.abspath('.')) sys.path.insert(0, os.path.abspath('..'))
# -- General configuration ------------------------------------------------ # -- General configuration ------------------------------------------------

6
doc/index.rst
View file

@ -16,6 +16,12 @@ a reference.
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
utils/filesystem
utils/network
utils/process
utils/stream
utils/text
Indices and tables Indices and tables
================== ==================

5
doc/utils/network.rst Normal file
View file

@ -0,0 +1,5 @@
Network operation utils
=======================
.. autofunction:: moulinette.utils.network.download_text
.. autofunction:: moulinette.utils.network.download_json

6
doc/utils/process.rst Normal file
View file

@ -0,0 +1,6 @@
Process operation utils
=======================
.. autofunction:: moulinette.utils.process.check_output
.. autofunction:: moulinette.utils.process.call_async_output
.. autofunction:: moulinette.utils.process.run_commands

5
doc/utils/stream.rst Normal file
View file

@ -0,0 +1,5 @@
Stream operation utils
======================
.. autofunction:: moulinette.utils.stream.consume_queue
.. autofunction:: moulinette.utils.stream.async_file_reading