e317c2d6d2
I have added a auto-generated documentation. It is done with Sphinx library. Sphinx uses reStructuredText as its markup language and docstrings as a source for automated documentation. According to https://www.python.org/dev/peps/pep-0257/ I used a """ for quotes in docstrings and made """Docstring."""-looking one-liners and correct indentation for multiple-liners. Based on https://github.com/kennethreitz/requests I moved Makefile, requirements.txt and conf.py to /doc folder. Also I decided to make fuel-qa documentation similar to https://docs.python.org/2/tutorial/index.html with single table of contents. I have added empty __init__.py files to be able to produce documentation. I have added sys_test.log to .gitigonre because it has been generated at the documentation build. To make it faster and non-conflicting I added some banal class descriptions in order to get them in auto-generated documentation. I decided not to fight with warnings and poor docstring descriptions I added to make documentation less conflicting and for a faster review. Docstring improvements and detailed code description are left for later. For the same reasons I decied not to add docstrings to all methods. At a places where I made poor docstrings I have added a TODO documentation. Change-Id: I7701a9a3429abbf62b13ec5a31972298c0be5201 Related-Bug: #1321682
51 lines
443 B
Plaintext
51 lines
443 B
Plaintext
*.py[cod]
|
|
|
|
# C extensions
|
|
*.so
|
|
|
|
# Packages
|
|
*.egg
|
|
*.egg-info
|
|
dist
|
|
build
|
|
eggs
|
|
parts
|
|
bin
|
|
var
|
|
sdist
|
|
develop-eggs
|
|
.installed.cfg
|
|
lib
|
|
lib64
|
|
MANIFEST
|
|
TAGS
|
|
|
|
# Installer logs
|
|
pip-log.txt
|
|
|
|
# Unit test / coverage reports
|
|
.coverage
|
|
.tox
|
|
nosetests.xml
|
|
|
|
# Translations
|
|
*.mo
|
|
|
|
# Mr Developer
|
|
.mr.developer.cfg
|
|
.project
|
|
.pydevproject
|
|
.idea
|
|
|
|
# Local example
|
|
example_local.py
|
|
|
|
# Local settings
|
|
local_settings.py
|
|
|
|
# Documentation
|
|
doc/_build/
|
|
|
|
# Logs
|
|
sys_test.log
|