Skip to content

Commit 5566eae

Browse files
committed
Merge branch 'ci-tests' into btd/master
2 parents 21570c6 + 1f60ef0 commit 5566eae

File tree

3 files changed

+164
-0
lines changed

3 files changed

+164
-0
lines changed

.github/workflows/publish.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Publish Python Package
2+
3+
on:
4+
push:
5+
tags:
6+
- '*'
7+
branches:
8+
- '*'
9+
10+
jobs:
11+
deploy:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v1
15+
- name: Set up Python
16+
uses: actions/setup-python@v1
17+
with:
18+
python-version: '3.x'
19+
- name: Install dependencies
20+
run: |
21+
python -m pip install --upgrade pip
22+
pip install setuptools wheel twine
23+
- name: Package and publish
24+
env:
25+
TWINE_USERNAME: __token__
26+
TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
27+
run: |
28+
python setup.py sdist bdist_wheel
29+
twine upload dist/*

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,48 @@
1+
[![Sourcecode on GitHub](https://img.shields.io/badge/BuildTheDocs-sphinx.graphviz-323131.svg?logo=github&longCache=true)](https://github.com/buildthedocs/sphinx.graphviz)
2+
<!--[![License](https://img.shields.io/badge/Apache%20License,%202.0-bd0000.svg?longCache=true&label=code%20license&logo=Apache&logoColor=D22128)](LICENSE.md)-->
3+
[![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)
4+
[![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)
5+
[![GitHub release date](https://img.shields.io/github/release-date/buildthedocs/sphinx.graphviz?logo=GitHub&)](https://github.com/buildthedocs/sphinx.graphviz/releases)
6+
[![Libraries.io status for latest release](https://img.shields.io/librariesio/release/pypi/btd.sphinx.graphviz)](https://libraries.io/github/buildthedocs/sphinx.graphviz)
7+
[![Requires.io](https://img.shields.io/requires/github/buildthedocs/sphinx.graphviz)](https://requires.io/github/buildthedocs/sphinx.graphviz/requirements/?branch=master)
8+
<!--[![Travis](https://img.shields.io/travis/com/buildthedocs/sphinx.graphviz?logo=Travis)](https://travis-ci.com/buildthedocs/sphinx.graphviz)-->
9+
[![PyPI](https://img.shields.io/pypi/v/btd.sphinx.graphviz?logo=PyPI)](https://pypi.org/project/sphinx.graphviz/)
10+
![PyPI - Status](https://img.shields.io/pypi/status/btd.sphinx.graphviz?logo=PyPI)
11+
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/btd.sphinx.graphviz?logo=PyPI)
12+
[![Dependent repos (via libraries.io)](https://img.shields.io/librariesio/dependent-repos/pypi/btd.sphinx.graphviz)](https://github.com/buildthedocs/sphinx.graphviz/network/dependents)
13+
<!-- [![Read the Docs](https://img.shields.io/readthedocs/btd-sphinx-graphviz)](https://btd-sphinx-graphviz.readthedocs.io/en/latest/)-->
14+
115
# btd.sphinx.graphviz
216

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

19+
> **Note:**
20+
> Patched versions of internal packages from Sphinx are released as M.M.P.postN
21+
> versions. So `2.3.1.post1` is the patched module version derived from Sphinx
22+
> `2.3.1`.
23+
524
--------------------
625

726
## Added features
827

928
* TBD
1029

30+
## Cross-References
31+
32+
* [`sphinx.ext.inheritance_diagram`](https://github.com/sphinx-doc/sphinx)
33+
If inheritance diagrams are enabled as an extension in Sphinx, these will
34+
reference `graphviz` and cause an `ImportError`. Please also install the
35+
patched variation [`btd.sphinx.inheritance_diagram`](https://github.com/buildthedocs/sphinx.inheritance_diagram),
36+
which patches internal cross-references.
37+
1138
--------------------
39+
40+
## Install using `pip`
41+
42+
```
43+
$ pip install btd.sphinx.graphviz
44+
```
45+
46+
----------------------
47+
1248
SPDX-License-Identifier: BSD-2-Clause

setup.py

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# EMACS settings: -*- coding: utf-8; tab-width: 2; indent-tabs-mode: t -*-
2+
# vim: tabstop=2:shiftwidth=2:noexpandtab
3+
# kate: tab-width 2; replace-tabs off; indent-width 2;
4+
# =============================================================================
5+
# Authors: Patrick Lehmann
6+
#
7+
# Package installer: A modified version of sphinx.ext.graphviz
8+
#
9+
#
10+
# License:
11+
# ============================================================================
12+
# Copyright 2017-2019 Patrick Lehmann - Bötzingen, Germany
13+
# Copyright (c) 2007-2019 by the Sphinx team (see AUTHORS file).
14+
# All rights reserved.
15+
16+
# Redistribution and use in source and binary forms, with or without
17+
# modification, are permitted provided that the following conditions are
18+
# met:
19+
# * Redistributions of source code must retain the above copyright
20+
# notice, this list of conditions and the following disclaimer.
21+
# * Redistributions in binary form must reproduce the above copyright
22+
# notice, this list of conditions and the following disclaimer in the
23+
# documentation and/or other materials provided with the distribution.
24+
25+
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26+
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27+
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28+
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29+
# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30+
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31+
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32+
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33+
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34+
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35+
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36+
#
37+
# SPDX-License-Identifier: BSD-2-Clause
38+
# ============================================================================
39+
#
40+
import setuptools
41+
42+
with open("README.md", "r") as file:
43+
long_description = file.read()
44+
45+
requirements = []
46+
with open("requirements.txt") as file:
47+
for line in file.readlines():
48+
requirements.append(line)
49+
50+
projectName = "sphinx.graphviz"
51+
projectNameWithPrefix = "btd." + projectName
52+
version = "2.3.1.post1.dev1"
53+
54+
github_url = "https://github.com/buildthedocs/" + projectName
55+
rtd_url = "https://" + projectNameWithPrefix.replace(".", "-") + ".readthedocs.io/en/latest/"
56+
57+
setuptools.setup(
58+
name=projectNameWithPrefix,
59+
version=version,
60+
61+
author="Sphinx team, Patrick Lehmann",
62+
author_email="[email protected]",
63+
# maintainer="Patrick Lehmann",
64+
# maintainer_email="[email protected]",
65+
66+
description="Embedding diagrams rendered with Graphviz.",
67+
long_description=long_description,
68+
long_description_content_type="text/markdown",
69+
70+
url=github_url,
71+
project_urls={
72+
'Documentation': rtd_url,
73+
'Source Code': github_url,
74+
'Issue Tracker': github_url + "/issues"
75+
},
76+
# download_url="https://github.com/buildthedocs/sphinx.graphviz/tarball/0.1.0",
77+
78+
packages=setuptools.find_namespace_packages(),
79+
classifiers=[
80+
"License :: OSI Approved :: BSD License",
81+
"Operating System :: OS Independent",
82+
"Programming Language :: Python :: 3 :: Only",
83+
"Programming Language :: Python :: 3.4",
84+
"Programming Language :: Python :: 3.5",
85+
"Programming Language :: Python :: 3.6",
86+
"Programming Language :: Python :: 3.7",
87+
"Programming Language :: Python :: 3.8",
88+
"Development Status :: 5 - Production/Stable",
89+
"Intended Audience :: Developers",
90+
"Topic :: Documentation :: Sphinx",
91+
"Framework :: Sphinx :: Extension"
92+
],
93+
keywords="Sphinx Documentation Graphviz",
94+
95+
python_requires='>=3.4',
96+
install_requires=requirements,
97+
# provides=
98+
# obsoletes=
99+
)

0 commit comments

Comments
 (0)