Merge pull request #41 from fedora-modularity/devel

Merge request to master

Author: phracek

.landscape.yaml

@@ -0,0 +1,20 @@
+# Include warnings about missing documentation?
+doc-warnings: False
+
+# Include warnings about tests?
+test-warnings: True
+
+# tests stricktness
+strictness: medium
+
+pylint:
+    options:
+        max-line-length: 120
+
+# autodetect dependencies?
+autodetect: True
+
+# paths to be ignored
+ignore-paths:
+    - docs
+    - setup.py

.tito/packages/modularity-testing-framework

@@ -1 +1 @@
-0.5.18-1 ./
+0.5.19-1 ./

README.md

@@ -1,3 +1,5 @@
+[![Code Health](https://landscape.io/github/fedora-modularity/meta-test-family/master/landscape.svg?style=flat)](https://landscape.io/github/fedora-modularity/meta-test-family/master)
+
 Meta test family (MTF) is a tool to test components of [a modular Fedora](https://docs.pagure.org/modularity/).
 
 For more information, check out the documentation page:

docs/api/exceptions_debug.rst renamed to docs/api/common.rst

@@ -1,5 +1,5 @@
-Exceptions and Debug
-====================
+Common
+=======
 
 .. automodule:: moduleframework.common
    :members:

docs/api/exceptions.rst

@@ -0,0 +1,7 @@
+Exceptions
+===========
+
+.. automodule:: moduleframework.exceptions
+   :members:
+   :undoc-members:
+

docs/api/index.rst

@@ -8,7 +8,8 @@ This section contains the MTF API, auto generated from `the source code`_.
 .. toctree::
 
    module_framework
-   exceptions_debug
+   common
+   exceptions
    mtf_generator
    compose_info
    pdc_data

docs/conf.py

@@ -254,7 +254,7 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  (master_doc, 'MetaTestfamily', u'Meta Test family Documentation',
+  (master_doc, 'MetaTestFamily', u'MetaTestFamily Documentation',
    u'Petr Hracek@*Jan Scotka', 'MetaTestFamily', 'One line description of project.',
    'Miscellaneous'),
 ]

docs/example-config-minimal.yaml

@@ -1,7 +1,7 @@
 document: modularity-testing
 version: 1
 name: bash
-modulemd-url: https://src.fedoraproject.org/cgit/modules/memcached.git/plain/memcached.yaml
+modulemd-url: https://src.fedoraproject.org/modules/memcached/raw/master/f/memcached.yaml
 packages:
     rpms:
         - bash

docs/example-config.yaml

@@ -12,7 +12,7 @@ name: memcached
 # link to default moduleMD file (usefull for local testing wihtout any repo)
 # env var: MODULEMDURL
 # MANDATORY (or compose-url)
-modulemd-url: https://src.fedoraproject.org/cgit/modules/memcached.git/plain/memcached.yaml
+modulemd-url: https://src.fedoraproject.org/modules/memcached/raw/master/f/memcached.yaml
 # final compose done by pungi (contain also modulemd files for modules) can suppy also previous part
 # env var: COMPOSEURL
 compose-url: url_to_compose_in done in fedora

docs/user_guide/index.rst

@@ -3,20 +3,20 @@ User Guide
 
 1. In a module's root directory create a directory ``tests`` and place there a module configuration file ``config.yaml`` described in detail in section `Configuration file`_.
 
-.. _Configuration file: how_to_write_conf_file
+.. _Configuration file: how_to_write_conf_file.html
 
 2. Optionally write multiline Bash snippet tests directly in the ``tests/config.yaml`` file as described in section `Multiline Bash snippet tests`_.
 
-.. _Multiline Bash snippet tests: how_to_write_conf_file#multiline-bash-snippet-tests
+.. _Multiline Bash snippet tests: how_to_write_conf_file.html#multiline-bash-snippet-tests
 
 3. Check the list of `Environment variables`_.
 
-.. _Environment variables: environment_variables
+.. _Environment variables: environment_variables.html
 
 4. Write your tests, for example see `sanity tests`_ and various tests examples in ``/usr/share/moduleframework/examples/testing-module/``. All tests methods are listed in section `API Index`_ and alphabetically in :ref:`genindex` section.
 
 .. _sanity tests: https://github.com/fedora-modularity/meta-test-family/blob/master/examples/template/sanity_template.py
-.. _API Index: ../api/index
+.. _API Index: ../api/index.html
 
 5. In the directory ``tests`` create a ``Makefile`` as below.