Skip to content

Commit

Permalink
Merge branch 'ci-tests' into btd/master
Browse files Browse the repository at this point in the history
  • Loading branch information
Paebbels committed Jan 12, 2020
2 parents 21570c6 + 1f60ef0 commit 5566eae
Show file tree
Hide file tree
Showing 3 changed files with 164 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Publish Python Package

on:
push:
tags:
- '*'
branches:
- '*'

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Set up Python
uses: actions/setup-python@v1
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install setuptools wheel twine
- name: Package and publish
env:
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
run: |
python setup.py sdist bdist_wheel
twine upload dist/*
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,48 @@
[![Sourcecode on GitHub](https://img.shields.io/badge/BuildTheDocs-sphinx.graphviz-323131.svg?logo=github&longCache=true)](https://github.com/buildthedocs/sphinx.graphviz)
<!--[![License](https://img.shields.io/badge/Apache%20License,%202.0-bd0000.svg?longCache=true&label=code%20license&logo=Apache&logoColor=D22128)](LICENSE.md)-->
[![GitHub tag (latest SemVer incl. pre-release)](https://img.shields.io/github/v/tag/buildthedocs/sphinx.graphviz?logo=GitHub&include_prereleases)](https://github.com/buildthedocs/sphinx.graphviz/tags)
[![GitHub release (latest SemVer incl. including pre-releases)](https://img.shields.io/github/v/release/buildthedocs/sphinx.graphviz?logo=GitHub&include_prereleases)](https://github.com/buildthedocs/sphinx.graphviz/releases/latest)
[![GitHub release date](https://img.shields.io/github/release-date/buildthedocs/sphinx.graphviz?logo=GitHub&)](https://github.com/buildthedocs/sphinx.graphviz/releases)
[![Libraries.io status for latest release](https://img.shields.io/librariesio/release/pypi/btd.sphinx.graphviz)](https://libraries.io/github/buildthedocs/sphinx.graphviz)
[![Requires.io](https://img.shields.io/requires/github/buildthedocs/sphinx.graphviz)](https://requires.io/github/buildthedocs/sphinx.graphviz/requirements/?branch=master)
<!--[![Travis](https://img.shields.io/travis/com/buildthedocs/sphinx.graphviz?logo=Travis)](https://travis-ci.com/buildthedocs/sphinx.graphviz)-->
[![PyPI](https://img.shields.io/pypi/v/btd.sphinx.graphviz?logo=PyPI)](https://pypi.org/project/sphinx.graphviz/)
![PyPI - Status](https://img.shields.io/pypi/status/btd.sphinx.graphviz?logo=PyPI)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/btd.sphinx.graphviz?logo=PyPI)
[![Dependent repos (via libraries.io)](https://img.shields.io/librariesio/dependent-repos/pypi/btd.sphinx.graphviz)](https://github.com/buildthedocs/sphinx.graphviz/network/dependents)
<!-- [![Read the Docs](https://img.shields.io/readthedocs/btd-sphinx-graphviz)](https://btd-sphinx-graphviz.readthedocs.io/en/latest/)-->

# btd.sphinx.graphviz

This is a patched version of [`sphinx.ext.graphviz`](https://github.com/sphinx-doc/sphinx).

> **Note:**
> Patched versions of internal packages from Sphinx are released as M.M.P.postN
> versions. So `2.3.1.post1` is the patched module version derived from Sphinx
> `2.3.1`.
--------------------

## Added features

* TBD

## Cross-References

* [`sphinx.ext.inheritance_diagram`](https://github.com/sphinx-doc/sphinx)
If inheritance diagrams are enabled as an extension in Sphinx, these will
reference `graphviz` and cause an `ImportError`. Please also install the
patched variation [`btd.sphinx.inheritance_diagram`](https://github.com/buildthedocs/sphinx.inheritance_diagram),
which patches internal cross-references.

--------------------

## Install using `pip`

```
$ pip install btd.sphinx.graphviz
```

----------------------

SPDX-License-Identifier: BSD-2-Clause
99 changes: 99 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
# EMACS settings: -*- coding: utf-8; tab-width: 2; indent-tabs-mode: t -*-
# vim: tabstop=2:shiftwidth=2:noexpandtab
# kate: tab-width 2; replace-tabs off; indent-width 2;
# =============================================================================
# Authors: Patrick Lehmann
#
# Package installer: A modified version of sphinx.ext.graphviz
#
#
# License:
# ============================================================================
# Copyright 2017-2019 Patrick Lehmann - Bötzingen, Germany
# Copyright (c) 2007-2019 by the Sphinx team (see AUTHORS file).
# All rights reserved.

# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.

# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# SPDX-License-Identifier: BSD-2-Clause
# ============================================================================
#
import setuptools

with open("README.md", "r") as file:
long_description = file.read()

requirements = []
with open("requirements.txt") as file:
for line in file.readlines():
requirements.append(line)

projectName = "sphinx.graphviz"
projectNameWithPrefix = "btd." + projectName
version = "2.3.1.post1.dev1"

github_url = "https://github.com/buildthedocs/" + projectName
rtd_url = "https://" + projectNameWithPrefix.replace(".", "-") + ".readthedocs.io/en/latest/"

setuptools.setup(
name=projectNameWithPrefix,
version=version,

author="Sphinx team, Patrick Lehmann",
author_email="Paebbels@gmail.com",
# maintainer="Patrick Lehmann",
# maintainer_email="Paebbels@gmail.com",

description="Embedding diagrams rendered with Graphviz.",
long_description=long_description,
long_description_content_type="text/markdown",

url=github_url,
project_urls={
'Documentation': rtd_url,
'Source Code': github_url,
'Issue Tracker': github_url + "/issues"
},
# download_url="https://github.com/buildthedocs/sphinx.graphviz/tarball/0.1.0",

packages=setuptools.find_namespace_packages(),
classifiers=[
"License :: OSI Approved :: BSD License",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: 3.4",
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"Topic :: Documentation :: Sphinx",
"Framework :: Sphinx :: Extension"
],
keywords="Sphinx Documentation Graphviz",

python_requires='>=3.4',
install_requires=requirements,
# provides=
# obsoletes=
)

0 comments on commit 5566eae

Please sign in to comment.