almalinux/lorax
13
0
Fork 0
Code Issues Pull Requests Releases Activity
1c06fccfe8
lorax/docs/pylorax.rst

135 lines
2.2 KiB
ReStructuredText
Raw Normal View History

Added Sphinx Documentation Run 'make docs' to update the apidocs. Also moves the README.livemedia-creator and README.product into docs as ReST documents. They will be installed in /usr/share/doc/lorax/ by the rpm package.
2015-04-08 21:02:26 +00:00
pylorax package
===============
Submodules
----------
New lorax documentation - 28.2
2017-11-28 17:18:51 +00:00
pylorax\.base module
--------------------
Added Sphinx Documentation Run 'make docs' to update the apidocs. Also moves the README.livemedia-creator and README.product into docs as ReST documents. They will be installed in /usr/share/doc/lorax/ by the rpm package.
2015-04-08 21:02:26 +00:00
.. automodule:: pylorax.base
:members:
:undoc-members:
:show-inheritance:
New lorax documentation - 28.2
2017-11-28 17:18:51 +00:00
pylorax\.buildstamp module
--------------------------
Added Sphinx Documentation Run 'make docs' to update the apidocs. Also moves the README.livemedia-creator and README.product into docs as ReST documents. They will be installed in /usr/share/doc/lorax/ by the rpm package.
2015-04-08 21:02:26 +00:00
.. automodule:: pylorax.buildstamp
:members:
:undoc-members:
:show-inheritance:
New lorax documentation - 28.2
2017-11-28 17:18:51 +00:00
pylorax\.cmdline module
-----------------------
Use Sphinx to generate manpages Use make -C docs man to regenerate the manpages in docs/man/
2016-03-18 23:27:47 +00:00
.. automodule:: pylorax.cmdline
:members:
:undoc-members:
:show-inheritance:
New lorax documentation - 28.2
2017-11-28 17:18:51 +00:00
pylorax\.decorators module
--------------------------
Added Sphinx Documentation Run 'make docs' to update the apidocs. Also moves the README.livemedia-creator and README.product into docs as ReST documents. They will be installed in /usr/share/doc/lorax/ by the rpm package.
2015-04-08 21:02:26 +00:00
.. automodule:: pylorax.decorators
:members:
:undoc-members:
:show-inheritance:
New lorax documentation - 28.2
2017-11-28 17:18:51 +00:00
pylorax\.discinfo module
------------------------
Added Sphinx Documentation Run 'make docs' to update the apidocs. Also moves the README.livemedia-creator and README.product into docs as ReST documents. They will be installed in /usr/share/doc/lorax/ by the rpm package.
2015-04-08 21:02:26 +00:00
.. automodule:: pylorax.discinfo
:members:
:undoc-members:
:show-inheritance:
New lorax documentation - 28.2
2017-11-28 17:18:51 +00:00
pylorax\.dnfhelper module
-------------------------
Added Sphinx Documentation Run 'make docs' to update the apidocs. Also moves the README.livemedia-creator and README.product into docs as ReST documents. They will be installed in /usr/share/doc/lorax/ by the rpm package.
2015-04-08 21:02:26 +00:00
.. automodule:: pylorax.dnfhelper
:members:
:undoc-members:
:show-inheritance:
New lorax documentation - 28.2
2017-11-28 17:18:51 +00:00
pylorax\.executils module
-------------------------
Added Sphinx Documentation Run 'make docs' to update the apidocs. Also moves the README.livemedia-creator and README.product into docs as ReST documents. They will be installed in /usr/share/doc/lorax/ by the rpm package.
2015-04-08 21:02:26 +00:00
.. automodule:: pylorax.executils
:members:
:undoc-members:
:show-inheritance:
New lorax documentation - 28.2
2017-11-28 17:18:51 +00:00
pylorax\.imgutils module
------------------------
Added Sphinx Documentation Run 'make docs' to update the apidocs. Also moves the README.livemedia-creator and README.product into docs as ReST documents. They will be installed in /usr/share/doc/lorax/ by the rpm package.
2015-04-08 21:02:26 +00:00
.. automodule:: pylorax.imgutils
:members:
:undoc-members:
:show-inheritance:
New lorax documentation - 28.2
2017-11-28 17:18:51 +00:00
pylorax\.ltmpl module
---------------------
Added Sphinx Documentation Run 'make docs' to update the apidocs. Also moves the README.livemedia-creator and README.product into docs as ReST documents. They will be installed in /usr/share/doc/lorax/ by the rpm package.
2015-04-08 21:02:26 +00:00
.. automodule:: pylorax.ltmpl
:members:
:undoc-members:
:show-inheritance:
New lorax documentation - 28.2
2017-11-28 17:18:51 +00:00
pylorax\.monitor module
-----------------------
Update Lorax documentation - 23.13 Add documentation for the new monitor and mount modules.
2015-07-10 18:39:39 +00:00
.. automodule:: pylorax.monitor
:members:
:undoc-members:
:show-inheritance:
New lorax documentation - 28.2
2017-11-28 17:18:51 +00:00
pylorax\.mount module
---------------------
Update Lorax documentation - 23.13 Add documentation for the new monitor and mount modules.
2015-07-10 18:39:39 +00:00
.. automodule:: pylorax.mount
:members:
:undoc-members:
:show-inheritance:
New lorax documentation - 28.2
2017-11-28 17:18:51 +00:00
pylorax\.output module
----------------------
Added Sphinx Documentation Run 'make docs' to update the apidocs. Also moves the README.livemedia-creator and README.product into docs as ReST documents. They will be installed in /usr/share/doc/lorax/ by the rpm package.
2015-04-08 21:02:26 +00:00
.. automodule:: pylorax.output
:members:
:undoc-members:
:show-inheritance:
New lorax documentation - 28.2
2017-11-28 17:18:51 +00:00
pylorax\.sysutils module
------------------------
Added Sphinx Documentation Run 'make docs' to update the apidocs. Also moves the README.livemedia-creator and README.product into docs as ReST documents. They will be installed in /usr/share/doc/lorax/ by the rpm package.
2015-04-08 21:02:26 +00:00
.. automodule:: pylorax.sysutils
:members:
:undoc-members:
:show-inheritance:
New lorax documentation - 28.2
2017-11-28 17:18:51 +00:00
pylorax\.treebuilder module
---------------------------
Added Sphinx Documentation Run 'make docs' to update the apidocs. Also moves the README.livemedia-creator and README.product into docs as ReST documents. They will be installed in /usr/share/doc/lorax/ by the rpm package.
2015-04-08 21:02:26 +00:00
.. automodule:: pylorax.treebuilder
:members:
:undoc-members:
:show-inheritance:
New lorax documentation - 28.2
2017-11-28 17:18:51 +00:00
pylorax\.treeinfo module
------------------------
Added Sphinx Documentation Run 'make docs' to update the apidocs. Also moves the README.livemedia-creator and README.product into docs as ReST documents. They will be installed in /usr/share/doc/lorax/ by the rpm package.
2015-04-08 21:02:26 +00:00
.. automodule:: pylorax.treeinfo
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: pylorax
:members:
:undoc-members:
:show-inheritance:
Reference in New Issue Copy Permalink