mirror of
https://github.com/openSUSE/osc.git
synced 2024-12-27 10:16:14 +01:00
improve documenation
removed tutorial. Added missing osc.util.helper added more modules: * OscConfigParser * build * conf * credentials
This commit is contained in:
parent
582ac00483
commit
26b2fea6d2
@ -8,3 +8,7 @@ These are the packages in the osc package.
|
||||
|
||||
osc.core
|
||||
osc.util
|
||||
osc.credentials
|
||||
osc.build
|
||||
osc.conf
|
||||
osc.OscConfigParser
|
||||
|
12
docs/api/osc.OscConfigParser.rst
Normal file
12
docs/api/osc.OscConfigParser.rst
Normal file
@ -0,0 +1,12 @@
|
||||
.. py:module:: osc.OscConfigParser
|
||||
|
||||
OscConfigParser
|
||||
====
|
||||
|
||||
This is the osc config parser.
|
||||
|
||||
basic structures
|
||||
----------------
|
||||
|
||||
.. automodule:: osc.OscConfigParser
|
||||
:members:
|
12
docs/api/osc.build.rst
Normal file
12
docs/api/osc.build.rst
Normal file
@ -0,0 +1,12 @@
|
||||
.. py:module:: osc.build
|
||||
|
||||
build
|
||||
====
|
||||
|
||||
This is the osc build module to talk to the build script.
|
||||
|
||||
basic structures
|
||||
----------------
|
||||
|
||||
.. automodule:: osc.build
|
||||
:members:
|
13
docs/api/osc.conf.rst
Normal file
13
docs/api/osc.conf.rst
Normal file
@ -0,0 +1,13 @@
|
||||
.. py:module:: osc.conf
|
||||
|
||||
conf
|
||||
====
|
||||
|
||||
This is the osc conf module.
|
||||
It handles the configuration of osc
|
||||
|
||||
basic structures
|
||||
----------------
|
||||
|
||||
.. automodule:: osc.conf
|
||||
:members:
|
@ -8,6 +8,9 @@ This is the osc core module.
|
||||
basic structures
|
||||
----------------
|
||||
|
||||
.. automodule:: osc.core
|
||||
:members:
|
||||
|
||||
.. autoclass:: File
|
||||
:members:
|
||||
|
||||
@ -18,3 +21,7 @@ basic structures
|
||||
|
||||
.. autoclass:: Linkinfo
|
||||
:members:
|
||||
|
||||
.. autoclass:: Project
|
||||
:members:
|
||||
|
||||
|
12
docs/api/osc.credentials.rst
Normal file
12
docs/api/osc.credentials.rst
Normal file
@ -0,0 +1,12 @@
|
||||
.. py:module:: osc.credentials
|
||||
|
||||
credentials
|
||||
====
|
||||
|
||||
This is the osc credentials module.
|
||||
|
||||
basic structures
|
||||
----------------
|
||||
|
||||
.. automodule:: osc.credentials
|
||||
:members:
|
@ -68,11 +68,10 @@ osc.util.safewriter module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
osc.util.helper module
|
||||
--------------------------
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: osc.util
|
||||
.. automodule:: osc.util.helper
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
@ -19,7 +19,6 @@ API:
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
api/tutorial
|
||||
api/modules
|
||||
|
||||
|
||||
@ -30,4 +29,3 @@ Indices and tables
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user