637d3ea643
mkksiso: Add documentation
2019-11-05 11:09:42 -08:00
2acd13d612
Make it easier to generate docs for the next release
...
Change the docs-in-docker target to generate the docs for the NEXT
release, not the current one. Also pass in uid/gid so that the new files
can be set to the correct ownership instead of root.
Modify docs/conf.py to bump the version of the docs if
LORAX_VERSION=next is set in the environment.
2019-03-26 16:55:51 -07:00
e85bcf4359
Turn off smartquotes in Sphinx documentation
...
It mangles the double dashes in the docstrings, and should close #155
2019-01-08 10:20:38 -08:00
7500a17f27
Build manpages for composer-cli and lorax-composer
...
Add manpage creation to make docs target to keep them updated.
2018-10-29 13:31:30 -07:00
07de4c371a
Ignore dnf.logging when building docs
2018-08-13 16:32:26 -07:00
0ff9a674ca
Add dnf.transaction to list of modules for sphinx to ignore
2018-07-20 15:48:18 -07:00
d47d38e0c8
Override Sphinx documentation version with LORAX_VERSION
...
Normally you want to document the NEXT release, not the last. This
allows you to build the documentation using:
LORAX_VERSION="29.6" make docs
2018-06-04 16:25:33 -07:00
e49c49ecb5
Update Copyright year to 2018 in Sphinx docs
2018-03-15 14:05:58 -07:00
e12f6b8ede
Use Sphinx to generate manpages
...
Use make -C docs man to regenerate the manpages in docs/man/
2016-03-21 14:21:56 -07:00
0b9077ceaa
Move argument parsers into pylorax.cmdline
...
This will make it possible to use sphinx-argparse to generate all the
documentation and manual pages.
2016-03-21 14:21:55 -07:00
0f0f01d51d
Create html documentation under docs/html/
2015-05-15 17:11:20 -07:00
a6e469e0e6
Clean up some pylint warnings
...
Mostly logging, using .format() on the strings.
2015-05-15 17:11:20 -07:00
9b384e084f
Mock more modules for RTD
...
Also add a requirements.txt for RTD so that it will install Mako into
the virtualenv when generating the documentation.
2015-04-09 11:01:20 -07:00
da59f8af4b
Mock the selinux package for RTD
2015-04-09 10:26:14 -07:00
f40dadf9be
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-09 09:29:56 -07:00
Brian C. Lane