General updates.

.github/pull_request_template.md

@@ -1,16 +1,30 @@
 # New Features
-
+
+* tbd
 * tbd
 
 # Changes
 
+* tbd
 * tbd
 
 # Bug Fixes
 
+* tbd
+* tbd
+
+# Documentation
+
+* tbd
+* tbd
+
+# Unit Tests
+
+* tbd
 * tbd
 
 ----------
-# Related PRs:
+# Related Issues and Pull-Requests
 
 * tbd
+* tbd

README.md

@@ -27,7 +27,7 @@ Unified Coverage Interoperability Standard (UCIS)
 
 ## Main Goals
 
-* Parse UCDB files and provide a UCDB data model.
+* Convert UCDB files and provide a UCDB data model.
 * Export and convert data from UCDB to Cobertura format.
 * Also support flavors not following the Unified Coverage Interoperability Standard (UCIS).
 

dist/requirements.txt

@@ -1,2 +1,2 @@
-wheel >= 0.40.0
-twine >= 4.0.2
+wheel ~= 0.45
+twine ~= 5.1

doc/_static/css/override.css

@@ -0,0 +1,115 @@
+/* theme overrides */
+.rst-content h1,
+.rst-content h2 {
+	margin-top: 24px;
+	margin-bottom: 6px;
+	text-decoration: underline;
+}
+
+.rst-content h3,
+.rst-content h4,
+.rst-content h5,
+.rst-content h6 {
+	margin-top: 12px;
+	margin-bottom: 6px;
+}
+
+.rst-content p {
+	margin-bottom: 6px
+}
+
+.rst-content .topic-title {
+	font-size: larger;
+	font-weight: 700;
+	margin-top: 18px;
+	margin-bottom: 6px;
+}
+
+.rst-content p.rubric {
+	text-decoration: underline;
+	font-weight: 700;
+	margin-top: 18px;
+	margin-bottom: 16px;
+}
+
+/* general overrides */
+html {
+	font-size: 15px;
+}
+
+footer {
+  font-size: 95%;
+  text-align: center
+}
+
+footer p {
+  margin-bottom: 0px /* 12px */;
+  font-size: 95%
+}
+
+section > p,
+.section p,
+.simple li {
+	text-align: justify
+}
+
+/* wyrm overrides */
+.wy-menu-vertical header,
+.wy-menu-vertical p.caption {
+	color: #9b9b9b /* #55a5d9 */;
+	padding: 0 0.809em /* 0 1.618em */;
+	margin: 6px 0 0 0 /* 12px 0 0 */;
+	border-top: 1px solid #9b9b9b;
+}
+
+.wy-side-nav-search {
+	margin-bottom: 0 /* .809em */;
+	background-color: #333333 /* #2980b9 */;
+	/* BTD: */
+	/*color: #fcfcfc*/
+}
+
+.wy-side-nav-search input[type=text] {
+	border-radius: 0px /* 50px */;
+}
+
+.wy-side-nav-search .wy-dropdown > a, .wy-side-nav-search > a {
+	/* BTD: */
+	/*color: #fcfcfc;*/
+	margin-bottom: 0.404em /* .809em */;
+}
+
+.wy-side-nav-search > div.version {
+  margin: 0 0 6px 0;
+  /* BTD: */
+  /*margin-top: -.4045em;*/
+}
+
+.wy-nav .wy-menu-vertical a:hover {
+  background-color:  #333333 /* #2980b9 */;
+}
+
+.wy-nav-content {
+  max-width: 1600px /* 800px */ ;
+}
+
+.wy-nav-top {
+  background:  #333333 /* #2980b9 */;
+}
+
+/* Sphinx Design */
+.sd-tab-set {
+	margin: 0
+}
+
+.sd-tab-set > label {
+	padding-top: .5em;
+	padding-right: 1em;
+	padding-bottom: .5em;
+	padding-left: 1em
+}
+
+.sd-container-fluid {
+	padding-left: 0;
+	padding-right: 0;
+}

doc/_templates/autoapi/module.rst

@@ -1,21 +1,21 @@
-.. # Template modified  by Patrick Lehmann
+.. # Template modified by Patrick Lehmann
      * removed automodule on top, because private members are activated for autodoc (no doubled documentation).
      * Made sections like 'submodules' bold text, but no headlines to reduce number of ToC levels.
 
-=={{ '=' * node.name|length }}==
-``{{ node.name }}``
-=={{ '=' * node.name|length }}==
+{{ '=' * node.name|length }}
+{{ node.name }}
+{{ '=' * node.name|length }}
 
-.. py:module:: {{ node.name }}
+.. automodule:: {{ node.name }}
 
 {##}
 {%- block modules -%}
 {%- if subnodes %}
 
 **Submodules**
 
-
 .. toctree::
+   :maxdepth: 1
 {% for item in subnodes %}
    {{ item.name }}
 {%- endfor %}
@@ -25,7 +25,17 @@
 {##}
 .. currentmodule:: {{ node.name }}
 {##}
-{%- block functions -%}
+
+{%- if node.variables %}
+
+**Variables**
+
+{% for item, obj in node.variables.items() -%}
+- :py:data:`{{ item }}`
+  {#{ obj|summary }#}
+{% endfor -%}
+{%- endif -%}
+
 {%- if node.functions %}
 
 **Functions**
@@ -35,15 +45,19 @@
   {{ obj|summary }}
 
 {% endfor -%}
+{%- endif -%}
 
-{% for item in node.functions %}
-.. autofunction:: {{ item }}
-{##}
-{%- endfor -%}
+{%- if node.exceptions %}
+
+**Exceptions**
+
+{% for item, obj in node.exceptions.items() -%}
+- :py:exc:`{{ item }}`:
+  {{ obj|summary }}
+
+{% endfor -%}
 {%- endif -%}
-{%- endblock -%}
 
-{%- block classes -%}
 {%- if node.classes %}
 
 **Classes**
@@ -53,14 +67,40 @@
   {{ obj|summary }}
 
 {% endfor -%}
+{%- endif -%}
 
-{% for item in node.classes %}
-.. autoclass:: {{ item }}
-   :members:
+{%- block variables -%}
+{%- if node.variables %}
 
-   .. rubric:: Inheritance
-   .. inheritance-diagram:: {{ item }}
-      :parts: 1
+---------------------
+
+**Variables**
+
+{#% for item, obj in node.variables.items() -%}
+- :py:data:`{{ item }}`
+{% endfor -%#}
+
+{% for item, obj in node.variables.items() %}
+.. autodata:: {{ item }}
+   :annotation:
+
+   .. code-block:: text
+
+      {{ obj|pprint|indent(6) }}
+{##}
+{%- endfor -%}
+{%- endif -%}
+{%- endblock -%}
+
+{%- block functions -%}
+{%- if node.functions %}
+
+---------------------
+
+**Functions**
+
+{% for item in node.functions %}
+.. autofunction:: {{ item }}
 {##}
 {%- endfor -%}
 {%- endif -%}
@@ -69,13 +109,15 @@
 {%- block exceptions -%}
 {%- if node.exceptions %}
 
+---------------------
+
 **Exceptions**
 
-{% for item, obj in node.exceptions.items() -%}
+{#% for item, obj in node.exceptions.items() -%}
 - :py:exc:`{{ item }}`:
   {{ obj|summary }}
 
-{% endfor -%}
+{% endfor -%#}
 
 {% for item in node.exceptions %}
 .. autoexception:: {{ item }}
@@ -88,22 +130,30 @@
 {%- endif -%}
 {%- endblock -%}
 
-{%- block variables -%}
-{%- if node.variables %}
+{%- block classes -%}
+{%- if node.classes %}
 
-**Variables**
+---------------------
 
-{% for item, obj in node.variables.items() -%}
-- :py:data:`{{ item }}`
-{% endfor -%}
+**Classes**
 
-{% for item, obj in node.variables.items() %}
-.. autodata:: {{ item }}
-   :annotation:
+{#% for item, obj in node.classes.items() -%}
+- :py:class:`{{ item }}`:
+  {{ obj|summary }}
 
-   .. code-block:: text
+{% endfor -%#}
 
-      {{ obj|pprint|indent(6) }}
+{% for item in node.classes %}
+.. autoclass:: {{ item }}
+   :members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :exclude-members: __weakref__
+
+   .. rubric:: Inheritance
+   .. inheritance-diagram:: {{ item }}
+      :parts: 1
 {##}
 {%- endfor -%}
 {%- endif -%}

doc/_templates/autoapi/package.rst

@@ -0,0 +1,14 @@
+.. # Template created by Patrick Lehmann
+
+Python Class Reference
+######################
+
+Reference of all packages and modules:
+
+.. automodule:: {{ node.name }}
+
+.. toctree::
+   :maxdepth: 1
+{% for item in subnodes %}
+   {{ item.name }}
+{%- endfor %}