v0.2.0

.btd.yml

@@ -0,0 +1,8 @@
+input: doc
+output: _build
+requirements: requirements.txt
+target: gh-pages
+formats: [ html ]
+images:
+  base: btdi/sphinx:pytooling
+theme: https://codeload.GitHub.com/buildthedocs/sphinx.theme/tar.gz/v1

.github/workflows/Pipeline.yml

@@ -0,0 +1,65 @@
+name: Pipeline
+
+on:
+  push:
+  workflow_dispatch:
+
+jobs:
+
+  Params:
+    uses: pyTooling/Actions/.github/workflows/Parameters.yml@r0
+    with:
+      name: pyEDAA.IPXACT
+
+  Package:
+    uses: pyTooling/Actions/.github/workflows/Package.yml@r0
+    needs:
+      - Params
+    with:
+      python_version: ${{ fromJson(needs.Params.outputs.params).python_version }}
+      artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.package }}
+
+  Release:
+    uses: pyTooling/Actions/.github/workflows/Release.yml@r0
+    if: startsWith(github.ref, 'refs/tags')
+    needs:
+      - Package
+
+  PublishOnPyPI:
+    uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@r0
+    if: startsWith(github.ref, 'refs/tags')
+    needs:
+      - Params
+      - Release
+      - Package
+    with:
+      python_version: ${{ fromJson(needs.Params.outputs.params).python_version }}
+      artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.package }}
+    secrets:
+      PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+
+  BuildTheDocs:
+    uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@r0
+    needs:
+      - Params
+    with:
+      artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.doc }}
+
+  PublishToGitHubPages:
+    uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r0
+    needs:
+      - Params
+      - BuildTheDocs
+    with:
+      doc: ${{ fromJson(needs.Params.outputs.params).artifacts.doc }}
+
+  ArtifactCleanUp:
+    uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r0
+    needs:
+      - Params
+      - BuildTheDocs
+      - PublishToGitHubPages
+    with:
+      package: ${{ fromJson(needs.Params.outputs.params).artifacts.package }}
+      remaining: |
+        ${{ fromJson(needs.Params.outputs.params).artifacts.doc }}

.gitignore

@@ -4,6 +4,7 @@ __pycache__/
 
 # Sphinx documentation
 doc/_build
+doc/_theme
 
 # PyCharm project
 /.idea/workspace.xml

README.md

@@ -1,19 +1,31 @@
-[![PyPI - License](https://img.shields.io/pypi/l/pyIPXACT?logo=PyPI)](LICENSE.md)
-[![GitHub tag (latest SemVer incl. pre-release)](https://img.shields.io/github/v/tag/Paebbels/pyIPXACT?logo=GitHub&include_prereleases)](https://github.com/Paebbels/pyIPXACT/tags)
-[![GitHub release (latest SemVer incl. including pre-releases)](https://img.shields.io/github/v/release/Paebbels/pyIPXACT?logo=GitHub&include_prereleases)](https://github.com/Paebbels/pyIPXACT/releases/latest)
-[![GitHub release date](https://img.shields.io/github/release-date/Paebbels/pyIPXACT?logo=GitHub&)](https://github.com/Paebbels/pyIPXACT/releases)
-[![Libraries.io status for latest release](https://img.shields.io/librariesio/release/pypi/pyIPXACT)](https://libraries.io/github/Paebbels/pyIPXACT)
-[![Requires.io](https://img.shields.io/requires/github/Paebbels/pyIPXACT)](https://requires.io/github/Paebbels/pyIPXACT/requirements/?branch=master)  
-[![Travis](https://img.shields.io/travis/com/Paebbels/pyIPXACT?logo=Travis)](https://travis-ci.com/Paebbels/pyIPXACT)
-[![PyPI](https://img.shields.io/pypi/v/pyIPXACT?logo=PyPI)](https://pypi.org/project/pyIPXACT/)
-![PyPI - Status](https://img.shields.io/pypi/status/pyIPXACT?logo=PyPI)
-![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyIPXACT?logo=PyPI)
-[![Dependent repos (via libraries.io)](https://img.shields.io/librariesio/dependent-repos/pypi/pyIPXACT)](https://github.com/Paebbels/pyIPXACT/network/dependents)  
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/3deb3840b05b40bf935380b41074bea9)](https://www.codacy.com/manual/Paebbels/pyIPXACT)
-[![Libraries.io SourceRank](https://img.shields.io/librariesio/sourcerank/pypi/pyIPXACT)](https://libraries.io/github/Paebbels/pyIPXACT/sourcerank)
-[![Read the Docs](https://img.shields.io/readthedocs/pyipxact)](https://pyIPXACT.readthedocs.io/en/latest/)
-
-# pyIPXACT - An IP-XACT DOM for [IEEE 1685-2014][IEEE-1685-2014] in Python.
+<p align="center">
+  <a title="edaa-org.github.io/pyEDAA.IPXACT" href="https://edaa-org.github.io/pyEDAA.IPXACT"><img height="80px" src="doc/_static/logo.svg"/></a>
+</p>
+
+[![Sourcecode on GitHub](https://img.shields.io/badge/pyEDAA-pyEDAA.IPXACT-29b6f6.svg?longCache=true&style=flat-square&logo=GitHub&labelColor=0277bd)](https://GitHub.com/edaa-org/pyEDAA.IPXACT)
+[![Sourcecode License](https://img.shields.io/pypi/l/pyEDAA.IPXACT?longCache=true&style=flat-square&logo=Apache&label=code)](LICENSE.md)
+[![Documentation](https://img.shields.io/website?longCache=true&style=flat-square&label=edaa-org.github.io%2FpyEDAA.IPXACT&logo=GitHub&logoColor=fff&up_color=blueviolet&up_message=Read%20now%20%E2%9E%9A&url=https%3A%2F%2Fedaa-org.github.io%2FpyEDAA.IPXACT%2Findex.html)](https://edaa-org.github.io/pyEDAA.IPXACT/)
+[![Documentation License](https://img.shields.io/badge/doc-CC--BY%204.0-green?longCache=true&style=flat-square&logo=CreativeCommons&logoColor=fff)](LICENSE.md)
+[![Gitter](https://img.shields.io/badge/chat-on%20gitter-4db797.svg?longCache=true&style=flat-square&logo=gitter&logoColor=e8ecef)](https://gitter.im/hdl/community)  
+[![PyPI](https://img.shields.io/pypi/v/pyEDAA.IPXACT?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)](https://pypi.org/project/pyEDAA.IPXACT/)
+![PyPI - Status](https://img.shields.io/pypi/status/pyEDAA.IPXACT?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyEDAA.IPXACT?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)  
+[![GitHub Workflow - Build and Test Status](https://img.shields.io/github/workflow/status/edaa-org/pyEDAA.IPXACT/Pipeline/main?longCache=true&style=flat-square&label=Build%20and%20Test&logo=GitHub%20Actions&logoColor=FFFFFF)](https://GitHub.com/edaa-org/pyEDAA.IPXACT/actions/workflows/Pipeline.yml)
+[![Libraries.io status for latest release](https://img.shields.io/librariesio/release/pypi/pyEDAA.IPXACT?longCache=true&style=flat-square&logo=Libraries.io&logoColor=fff)](https://libraries.io/github/edaa-org/pyEDAA.IPXACT)
+
+
+<!--
+[![Codacy - Quality](https://img.shields.io/codacy/grade/3deb3840b05b40bf935380b41074bea9?longCache=true&style=flat-square&logo=Codacy)](https://app.codacy.com/gh/edaa-org/pyEDAA.IPXACT)
+[![Codacy - Coverage](https://img.shields.io/codacy/coverage/3deb3840b05b40bf935380b41074bea9?longCache=true&style=flat-square&logo=Codacy)](https://app.codacy.com/gh/edaa-org/pyEDAA.IPXACT)
+[![Codecov - Branch Coverage](https://img.shields.io/codecov/c/github/edaa-org/pyEDAA.IPXACT?longCache=true&style=flat-square&logo=Codecov)](https://codecov.io/gh/edaa-org/pyEDAA.IPXACT)
+
+
+[![Dependent repos (via libraries.io)](https://img.shields.io/librariesio/dependent-repos/pypi/pyEDAA.IPXACT?longCache=true&style=flat-square&logo=GitHub)](https://GitHub.com/edaa-org/pyEDAA.IPXACT/network/dependents)
+[![Requires.io](https://img.shields.io/requires/github/edaa-org/pyEDAA.IPXACT?longCache=true&style=flat-square)](https://requires.io/github/EDAA-ORG/pyEDAA.IPXACT/requirements/?branch=main)
+[![Libraries.io SourceRank](https://img.shields.io/librariesio/sourcerank/pypi/pyEDAA.IPXACT?longCache=true&style=flat-square)](https://libraries.io/github/edaa-org/pyEDAA.IPXACT/sourcerank)
+-->
+
+An IP-XACT Document Object Model (DOM) for [IEEE 1685-2014][IEEE-1685-2014] written in Python.
 
 ## Features
 
@@ -38,10 +50,9 @@
 
 ## License
 
-This library is licensed under [Apache License 2.0](LICENSE.md)
+This Python library (source code) is licensed under [Apache License 2.0](LICENSE.md).
 
 -------------------------
-
 SPDX-License-Identifier: Apache-2.0
 
 

doc/Makefile

@@ -0,0 +1,11 @@
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees -T -D language=en $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+%:
+	$(SPHINXBUILD) -b $@ $(ALLSPHINXOPTS) $(BUILDDIR)/$@

doc/conf.py

@@ -1,22 +1,18 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Path setup --------------------------------------------------------------
-
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-import os
-import sys
-#sys.path.insert(0, os.path.abspath('.'))
-sys.path.insert(0, os.path.abspath('..'))
-#sys.path.insert(0, os.path.abspath('../pyIPXACT'))
-#sys.path.insert(0, os.path.abspath('_extensions'))
-#sys.path.insert(0, os.path.abspath('_themes/sphinx_rtd_theme'))
+# documentation root, use abspath to make it absolute, like shown here.
+
+from sys import path as sys_path
+from os.path import abspath
+from pathlib import Path
+from json import loads
+
+ROOT = Path(__file__).resolve().parent
+
+sys_path.insert(0, abspath('..'))
+#sys_path.insert(0, abspath('../pyIPXACT'))
+#sys_path.insert(0, abspath('_extensions'))
+#sys_path.insert(0, abspath('_themes/sphinx_rtd_theme'))
 
 
 # -- Project information -----------------------------------------------------
@@ -35,8 +31,6 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-# Sphinx theme
-	"sphinx_rtd_theme",
 # Standard Sphinx extensions
 	"sphinx.ext.autodoc",
 	'sphinx.ext.extlinks',
@@ -64,24 +58,49 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = [
 	"_build",
+	"_theme",
 	"Thumbs.db",
 	".DS_Store"
 ]
 
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'stata-dark'
+
 
 # -- Options for HTML output -------------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-# html_theme = 'alabaster'
-html_theme = 'sphinx_rtd_theme'
+html_context = {}
+ctx = ROOT / 'context.json'
+if ctx.is_file():
+	html_context.update(loads(ctx.open('r').read()))
+
+if (ROOT / "_theme").is_dir():
+	html_theme_path = ["."]
+	html_theme = "_theme"
+	html_theme_options = {
+		'logo_only': True,
+		'home_breadcrumbs': False,
+		'vcs_pageview_mode': 'blob',
+	}
+else:
+	html_theme = "alabaster"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
+html_logo = str(Path(html_static_path[0]) / "logo.svg")
+html_favicon = str(Path(html_static_path[0]) / "favicon.svg")
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'pyEDAAIPXACTDoc'
+
+# If not None, a 'Last updated on:' timestamp is inserted at every page
+# bottom, using the given strftime format.
+# The empty string is equivalent to '%b %d, %Y'.
+html_last_updated_fmt = "%d.%m.%Y"
+
 # ==============================================================================
 # Sphinx.Ext.InterSphinx
 # ==============================================================================
@@ -102,10 +121,9 @@
 # Sphinx.Ext.ExtLinks
 # ==============================================================================
 extlinks = {
-	'issue': ('https://github.com/Paebbels/pyIPXACT/issues/%s', 'issue #'),
-	'pull':  ('https://github.com/Paebbels/pyIPXACT/pull/%s', 'pull request #'),
-	'src':   ('https://github.com/Paebbels/pyIPXACT/blob/master/pyIPXACT/%s?ts=2', None),
-#	'test':  ('https://github.com/Paebbels/pyIPXACT/blob/master/test/%s?ts=2', None)
+	'ghissue': ('https://github.com/edaa-org/pyEDAA.IPXACT/issues/%s', 'issue #'),
+	'ghpull':  ('https://github.com/edaa-org/pyEDAA.IPXACT/pull/%s', 'pull request #'),
+	'ghsrc':   ('https://github.com/edaa-org/pyEDAA.IPXACT/blob/main/%s', ''),
 }