Documentation without Frustration
or how to get a software developer to write documentation
Written for software developers, software team leads and everybody who hates writing docs.
Press S to open speaker notes view or ESC for slides overview.
Presentation can be freely used, forked and changed for meetups and co.
TOC
What belongs to “Documentation”
Why writing documentation frustrates us
What is needed to keep motivation high enough
How Sphinx and PlantUML supports developers
Sphinx-Needs benefits and features
Professional Services for companies
Which Cloud Services save a lot of time
What belongs to documentation?
Nearly anything you can imagine
… and much more.
Which tools can to be used for docs?
Nearly anything you can imagine:
… and much more.
Your turn!
How many tools do you weekly need to fulfill your work?
Potential of Frustration
Team Setup Example
Frontend - Backend - Infrastructure
Each developer is responsible for the complete documentation of his/her domain.
Potential of Frustration 1/2
For each document type you may need a different tool
Frustration: Tool-KnowHow needed
Frustration: Context/tool switches during development
Most tools forces you to somehow “style” your information
Frustration: Spend time for not functional nor informative work
Potential of Frustration 2/2
No synchronisation with existing code
Frustration: Maintain same code / information at different locations
No common storage, versioning or release for documentations and code
Frustration: Nothing is in sync
Your turn!
Tell your own story of why you avoid certain tools?
Motivation Boosters
Who needs to be motivated?
The content authors!
KISS
IDEs integrate different kinds of inputs to create multiple outputs
KISS = Keep It Short and Simple
Documentation = Code
Same requirements for code and documentation
Editable inside IDE (text, images, diagrams, everything!)
Text based files
Stored and version-controlled beside the code
Deeply linked with code (e.g. reuse of docstrings)
Focused on information and not on layout or design
Supports continuous integration / deployment
Example
My code document
================
This little piece of text describes the function
:ref:`my_package.my_module.my_class.my_func`.
Docstring
---------
.. autofunction:: my_package.my_module.my_class.my_func
Inheritance diagram
-------------------
.. inheritance-diagram:: my_package.my_module.my_class
Code example
------------
You can use the function like this::
test_class = MyClass()
return_value = test_class.my_func(some_data)Sphinx
Documentation generator
Takes text and code files, generates …
Sphinx, based on docutils and restructuredText
Projects using Sphinx
|
|
|
|
|
readthedocs.io : ~240k projects and ~430k users
pypi.org : ~515 extensions & themes for Sphinx
Sphinx Basics
Text 1/4
Sphinx Basics
=============
Text styles
------------
**bold text** *italic text* ``code sample``
Links
-----
http://dwf.rtfd.io
`Documentation without frustration <http://dwf.rtfd.io>`_Sphinx documentation: reStructuredText Primer
Lists 2/4
Unsorted list
=============
* Item 1
* Item 2
* Item 2.1
* Item 2
Sorted list
===========
#. Item 1
#. Item 2Sphinx documentation: reStructuredText Primer
Images & Tables 3/4
Images
======
.. image:: my_image.png
:scale: 50%
Tables
======
===== ===== =======
A B A and B
===== ===== =======
False False False
True False False
False True False
True True True
===== ===== =======Sphinx documentation: reStructuredText Primer
Code 4/4
Source Code
===========
Just use two of it::
def func(me):
return me
Or for more details:
.. code-block:: python
:linenos:
:emphasize-lines: 1,3
def func(a, b):
c = a + b
return cSphinx documentation: Showing code examples
Working with existing code
Reuse existing code 1/5
.. literalinclude:: /slides/sphinx_code.rst
:language: rst
:lines: 3-10
:linenos:Result:
Reuse existing code 1/5
~~~~~~~~~~~~~~~~~~~~~~~
.. code-block::
.. literalinclude:: /slides/sphinx_code.rst
:language: rst
Sphinx documentation: Showing code examples
Automated code documentation 2/5
.. autofunction:: os.path.joinResult:
- os.path.join(a, *p)
Join two or more pathname components, inserting ‘/’ as needed. If any component is an absolute path, all previous path components will be discarded. An empty last part will result in a path that ends with a separator.
Sphinx documentation: Include documentation from docstrings
Inheritance diagrams 3/5
.. inheritance-diagram:: dwf.Dwf
Used code (examples/dwf/dwf.py):
class Tool: pass
class Documentation(Tool): pass
class Frustration(Tool): pass
class Dwf(Documentation, Frustration, Tool): pass
Sphinx documentation: Include inheritance diagrams
Documenting program output 4/5
.. command-output:: python -VResult:
$ python -V
Python 3.8.12Sphinx documentation: sphinxcontrib.programoutput
Documenting database models 5/5
.. sadisplay::
:module: dwf_db
Sphinx documentation: sphinxcontrib-sadisplay
Standalone tool: sadisplay
PlantUML
Tool: PlantUML
Sphinx documentation: sphinx-plantuml
Class diagrams - Result
Class diagrams - Code
@startuml
class user {
name
age
email
check_password()
send_email(message)
}
class domain
class group
class api_key
class permission
user --> domain
user --> group
user --> api_key
user --> permission: 1:n
group --> permission: 1:n
@endumlPlantUML documentation: Class diagram
Sequence diagrams - Result
Sequence diagrams - Code
@startuml
user --> server : send request
server --> server: check request
server --> database: ask for data
database --> server: provide data
server --> server: render data
server --> user: send rendered data
@endumlPlantUML documentation: Sequence diagram
PyCharm Integration
Plugin: IntelliJ PlantUML Integration
Sphinx-Needs
Extension to manage requirements, specifications or test cases
Can be configured to support other types. Like user stories, bugs, servers, …
Developed to support ISO 26262 inside Sphinx
Sphinx Documentation: Sphinx-needs
Need-Objects
We need to use the unique email address for user login and verification 
|
Need-Objects Code
.. story:: As user I want to be able to use my email address for login
:id: US_001
:tags: user; login; email, security
We need to use the unique email address for user login and verification
.. uml::
object Alice
object Bob
Alice --> Bob
.. spec:: Use flask-login for secure user verification and authorisation
:tags: user, security
:id: SP_001
:link: US_001Sphinx-Needs documentation: need/ req (or any other defined need type)
Need-Objects Filtering
As list
.. needlist::
:tags: securitySphinx-Needs documentation: needfilter
Need-Objects Filtering with complex filter
As table
.. needtable::
:filter: id == "US_001" or "security" in tags
:columns: id, title, outgoing
:layout: tableNeed-Objects Filtering with regex
As diagram
.. needflow::
:filter: search("\w{5,}", title) and "security" in tags # word with at least 5 chars inside title
Other filter result types
This presentation has 3 open needs.
This presentation has :need_count:`status == "open"` open needs.
Docs: | need_count | needsequence | needgantt | needbar
Sphinx-Needs Structure
Embedded needs 1/2
.. story:: My parent story
:id: ST_PAR_001
This parent need contains the following need:
.. story:: My child story
:id: ST_CHIlD_001
:style: red_border
This is the child need.Embedded needs 2/2
This parent need contains the following need:
|
Need parts 1/2
.. story:: A Story with parts
:id: ST_PARTS_001
:links: ST_PARTS_001.1, ST_PARTS_001.nothing
As awesome user I want to:
* :need_part:`(1)Get everything`
* :np:`(nothing)Be responsible for nothing`Need parts 2/2
As awesome user I want to: |
Sphinx-Needs Customization
Types
needs_types = [
dict(
directive="req",
title="Requirement",
prefix="R_",
color="#BFD8D2",
style="node"
),
dict(directive="spec", title="Specification", prefix="S_", color="#FEDCD2", style="node"),
]Sphinx-Needs: Need Types
PlantUML: Styles
Links
needs_extra_links = [
{
"option": "triggers",
"incoming": "is triggered by",
"outgoing": "triggers",
"copy": False,
"allow_dead_links": True,
"style": "#00AA00"
"style_part": "#00AA00"
"style_start": "-",
"style_end": "--o",
}
]Sphinx-Needs: Need Links
PlantUML: Line styles
Layout
.. story:: Layout example
:layout: complete
.. story:: Layout example
:layout: focusLayout example
|
User Story
|
||||
Some content |
|||||
Some content |
Sphinx-Needs: Layouts
Styles
|
|
|
|
Sphinx-Needs: Styles
Sphinx-Needs: Table Row Styles
Sphinx-Needs Automation
Dynamic Functions
.. story:: Dynamic Functions
:id: US_DF
:status: open
:linked_status: [[copy("status", 'US_002')]]
This need has the id **[[copy("id")]]** and status **[[copy("status")]]**.This need has the id US_DF and status open. |
Sphinx-Needs: Dynamic Functions
Global Options
needs_global_options = {
'global_option': 'Fix value',
'author': ('Marco', '"security" in tags', 'Daniel)
'status':[
('closed', 'status.lower() in ["done", "resolved", "closed"]'),
('open', 'status.lower() in ["open", "new"]')
]
}Sphinx-Needs: needs_global_options
Warnings
def my_custom_warning_check(need, log):
if need["status"] == "open":
log.info(f"{need['id']} status must not be 'open'.")
return True
return False
needs_warnings = {
'invalid_status' : "status not in ['open', 'closed']",
'type_match': my_custom_warning_check,
}Build log:
Checking sphinx-needs warnings
type_match: passed
invalid_status: failed
failed needs: 2 (US_001, US_002)
used filter: status not in ['open', 'closed']Sphinx-Needs: needs_warnings
Template 1/2
/my_file.rst
.. spec:: My specification
:id: TEMPL_POST_SPEC
:links: US_003, US_004
:post_template: post_template
This is my **specification** content./needs_templates/post_template.need
**Analytics for above need:** {{title}}
.. needflow::
:filter: id == '{{id}}' or '{{id}}' in links_backSphinx-Needs: post_template
Template 2/2
This is my specification content. |
Analytics for above need: My specification
![@startuml
' Nodes definition
node "<size:12>User Story</size>\n**Layout example**\n<size:10>US_003</size>" as US_003 [[../index.html#US_003]] #BFD8D2
node "<size:12>User Story</size>\n**Style example**\n<size:10>US_004</size>" as US_004 [[../index.html#US_004]] #BFD8D2
node "<size:12>Specification</size>\n**My**\n**specification**\n<size:10>TEMPL_POST_SPEC</size>" as TEMPL_POST_SPEC [[../index.html#TEMPL_POST_SPEC]] #FEDCD2
' Connection definition
TEMPL_POST_SPEC --> US_003
TEMPL_POST_SPEC --> US_004
@enduml](_images/plantuml-1e0806137d9011d48dacfea8aa90d02f64cc3417.svg)
Debug Layout 1/2
.. story:: Debug
:id: US_DEBUG
:status: open
:layout: debugUS_DEBUG Debug
Debug view onDebug view off
|
Sphinx-Needs: Debug Layout
Debug Layout 2/2
.. needflow::
:filter: id == 'TEMPL_POST_SPEC' or 'TEMPL_POST_SPEC' in links_back
:debug:Sphinx-Needs: needflow debug
@startuml ' Nodes definition node "<size:12>User Story</size>\n**Layout example**\n<size:10>US_003</size>" as US_003 [[../index.html#US_003]] #BFD8D2 node "<size:12>User Story</size>\n**Style example**\n<size:10>US_004</size>" as US_004 [[../index.html#US_004]] #BFD8D2 node "<size:12>Specification</size>\n**My**\n**specification**\n<size:10>TEMPL_POST_SPEC</size>" as TEMPL_POST_SPEC [[../index.html#TEMPL_POST_SPEC]] #FEDCD2 ' Connection definition TEMPL_POST_SPEC --> US_003 TEMPL_POST_SPEC --> US_004 @enduml
Sphinx-Needs Data Exchange
Export
make needs# File: _build/needs/needs.json
{
"created": "2017-09-21T20:40:49.090464",
"current_version": "1.0",
"project": "Documentation without Frustration",
"versions": {
"1.0": {
"created": "2017-09-21T20:40:49.090443",
"needs": {
"SP_002": {
"description": "",
"id": "SP_001",
"links": [
"US_002"
],
"status": null,
"tags": [
"user"
],
"title": "Use flask-login for secure user verification and authorisation",
"type": "spec",
"type_name": "Specification"
},
"US_002": {
"description": "We need to use the unique email address for user login and verification\n\n.. uml::\n\n @startuml\n rectangle Alice\n rectangle Bob\n Alice -right-> Bob\n @enduml",
"id": "US_002",
"links": [],
"status": null,
"tags": [
"user",
"login",
"email"
],
"title": "As user I want to be able to use my email address for login",
"type": "story",
"type_name": "User Story"
}
},
"needs_amount": 2
}
}
}Sphinx-Needs documentation: Builders
Import
.. needimport:: /needs.json
:id_prefix: IMP_
:version: 1.0
:tags: imported
:filter: "SP" in idSphinx-Needs documentation: needimport
External Needs
needs_external_needs = [
{
'base_url': 'http://mydocs/my_project',
'json_url': 'http://mydocs/my_project/needs.json',
'version': '1.0',
'id_prefix': 'ext_',
'css_class': 'external_link',
}
]Sphinx-Needs documentation: needs_external_needs
Services
.. needservice:: github-issues
:query: repo:useblocks/sphinxcontrib-needs state:closed needtable viewports
:max_amount: 1needtable is invisible on wide viewports when using 'read the docs' theme (url)
|
 danieleades
|
||||
|
|||||
Sphinx-Needs documentation: GitHub service
Sphinx-Needs-Enterprise
Ready to use Ex- and Importers:
Azure DevOps, codebeamer, Jira, Elasticsearch
Supported targets:
Documentation build, needs.json file
Sphinx-Needs API
Open API, which can be accessed during build to:
Configure own types and options
Add needs (internal and external)
Add own warnings
for element in my_data:
section += add_need(
self.env.app, self.state, docname, self.lineno,
need_type="req", title=element["title"],
id=element["key"], content=element["description"])Sphinx-Needs documentation: API
Example integration: Sphinx-Test-Reports
Sphinx Performance
Executed measurements
Sphinx-Performance
Sphinx-Needs Profiling
Sphinx Universe
Solutions for engineering related companies.
Project team size: > 100
Document test results inside Sphinx.
Automatically connect results with test cases.
Based on Sphinx-Needs and junit.xml
Collects source files from different sources:
Git repositories
Local folders
Jinja templates
Functions
Im- and Exporter to different systems:
Azure DevOps
Codebeamer
Jira
ElasticSearch
more on request
Further extensions
Sphinx-Bazel (deprecated)
Support & Services
Open-Source Support
✅ |
No costs |
✅ / ⛔ / ⛔ |
Issues / E-Mails / Calls |
✅ / ⛔ |
Public / Private discussion |
🯄 |
Answers in time |
⛔ |
Prioritization |
⛔ |
Implementation guarantee |
🯄 |
Process / Domain knowledge |
Professional Support
⛔ |
No costs |
✅ / ✅ / ✅ |
Issues / E-Mails / Calls |
✅ / ✅ |
Public / Private discussion |
✅ |
Answers in time |
✅ |
Prioritization |
🯄 |
Implementation guarantee
(as fork ✅)
|
✅ |
Process / Domain knowledge |
Professional Services
Tool Development
Tool rollout (CI / CD)
Process Consulting
Process & Tools Trainings
Open-Source Transformation of in-house solutions
Open-Source Project gardening
Professional Trainings
Docs-as-Code
Sphinx
Sphinx-Needs
Features
Development / API
Processes (company specific)
(Cloud) Services
GitHub
Store code and files with git
Get issue tracker, wiki, website and more
Automatically interacts with hundreds of other web services
Free for open-source projects
Link: github.com
Read the docs
Builds, deploys and hosts sphinx documentations
Gets triggered by changes on github
Free for open-source projects
Link: readthedocs.org
Artifactory
Archiving releases, binaries and co.
Multiple Archive types: PyPi, NPM, Generic
Link: Artifactory
Thanks for your attention …
… and see you on DWF’s issue tracker :)
github |
|
This presentation |
Maintainer
Daniel Woste
LICENSE
Presentation and Documentation
==============================
Creative Common 4.0 International
https://creativecommons.org/licenses/by/4.0/legalcode
Copyright (c) 2016-2017 useblocks GmbH
Creative Commons Attribution 4.0 International Public License
By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
Section 1 – Definitions.
Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
Licensor means the individual(s) or entity(ies) granting rights under this Public License.
Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
Section 2 – Scope.
License grant.
Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
reproduce and Share the Licensed Material, in whole or in part; and
produce, reproduce, and Share Adapted Material.
Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
Term. The term of this Public License is specified in Section 6(a).
Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
Downstream recipients.
Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
Other rights.
Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
Patent and trademark rights are not licensed under this Public License.
To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
Section 3 – License Conditions.
Your exercise of the Licensed Rights is expressly made subject to the following conditions.
Attribution.
If You Share the Licensed Material (including in modified form), You must:
retain the following if it is supplied by the Licensor with the Licensed Material:
identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
a copyright notice;
a notice that refers to this Public License;
a notice that refers to the disclaimer of warranties;
a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
If You Share Adapted Material You produce, the Adapter's License You apply must not prevent recipients of the Adapted Material from complying with this Public License.
Section 4 – Sui Generis Database Rights.
Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database;
if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material; and
You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
Section 5 – Disclaimer of Warranties and Limitation of Liability.
Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.
To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.
The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
Section 6 – Term and Termination.
This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
upon express reinstatement by the Licensor.
For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
Section 7 – Other Terms and Conditions.
The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
Section 8 – Interpretation.
For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.
Software
========
MIT License
Copyright (c) 2016-2017 useblocks GmbH
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.