Skip to content

Commit ac900dc

Browse files
LecrisUTcholdgraf
LecrisUT
and
choldgraf
authored
Improve tests and codebase structure to Pep621 (#68)
Co-authored-by: choldgraf <choldgraf@gmail.com>
1 parent f6dc068 commit ac900dc

17 files changed

Lines changed: 162 additions & 131 deletions

‎.git_archival.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
node: $Format:%H$
2+
node-date: $Format:%cI$
3+
describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$
4+
ref-names: $Format:%D$

‎.github/workflows/publish.yml‎

Lines changed: 0 additions & 33 deletions
This file was deleted.

‎.github/workflows/release.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# This will run every time a tag is created and pushed to the repository.
2+
# It calls our tests workflow via a `workflow_call`, and if tests pass
3+
# then it triggers our upload to PyPI for a new release.
4+
name: Make a new release
5+
on:
6+
push:
7+
tags:
8+
- "v[0-9]+.[0-9]+.[0-9]+"
9+
- "v[0-9]+.[0-9]+.[0-9]+-rc[0-9]+"
10+
11+
jobs:
12+
tests:
13+
uses: ./.github/workflows/tests.yml
14+
dist:
15+
name: publish
16+
needs: [tests] # require tests to pass before deploy runs
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: Checkout source
20+
uses: actions/checkout@v3
21+
- name: Set up Python 3.11
22+
uses: actions/setup-python@v4
23+
with:
24+
python-version: 3.11
25+
- name: Build package
26+
run: pipx run build
27+
- uses: actions/upload-artifact@v3
28+
with:
29+
path: dist/*
30+
upload_pypi:
31+
name: publish
32+
needs: [dist]
33+
runs-on: ubuntu-latest
34+
steps:
35+
- uses: actions/download-artifact@v3
36+
with:
37+
name: artifact
38+
path: dist
39+
- name: Publish
40+
uses: pypa/gh-action-pypi-publish@v1.6.4
41+
with:
42+
user: __token__
43+
password: ${{ secrets.PYPI_KEY }}
44+
release:
45+
needs: [ upload_pypi ]
46+
name: Create release
47+
runs-on: ubuntu-latest
48+
steps:
49+
- uses: actions/checkout@v3
50+
- uses: softprops/action-gh-release@v1
51+
with:
52+
name: Sphinx thebe ${{ github.ref_name }}
53+
prerelease: ${{ contains(github.ref, 'rc') }}
54+
generate_release_notes: true

‎.github/workflows/tests.yml‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: continuous-integration
22

33
on:
44
push:
5-
branches: [master]
5+
branches: [main]
66
tags:
77
- 'v*'
88
pull_request:
@@ -12,19 +12,23 @@ jobs:
1212
docs:
1313
runs-on: ubuntu-latest
1414
strategy:
15+
fail-fast: false
1516
matrix:
16-
python-version: [3.7, 3.8, 3.9]
17+
python-version: ["3.8", "3.9", "3.10", "3.11"]
18+
# Latest and 2 major releases earlier
19+
sphinx: [ "~=5.0", "~=7.0" ]
1720

1821
steps:
19-
- uses: actions/checkout@v2
22+
- uses: actions/checkout@v3
2023
- name: Set up Python ${{ matrix.python-version }}
21-
uses: actions/setup-python@v1
24+
uses: actions/setup-python@v4
2225
with:
2326
python-version: ${{ matrix.python-version }}
24-
- name: Install dependencies
27+
cache: pip
28+
- name: Install sphinx-thebe with sphinx ${{ matrix.sphinx }}
2529
run: |
26-
python -m pip install --upgrade pip
27-
pip install -e .[sphinx,testing]
30+
pip install --upgrade pip
31+
pip install --upgrade "Sphinx${{ matrix.sphinx }}" -e .[testing]
2832
- name: Run tests
2933
run: |
3034
pytest

‎.gitignore‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,4 +128,6 @@ dmypy.json
128128
# Pyre type checker
129129
.pyre/
130130

131-
docs/_build
131+
### Project specific
132+
docs/_build
133+
_version.py

‎MANIFEST.in‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎docs/conf.py‎

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,3 @@
1-
# -*- coding: utf-8 -*-
2-
#
3-
# Configuration file for the Sphinx documentation builder.
4-
#
5-
# This file does only contain a selection of the most common options. For a
6-
# full list see the documentation:
7-
# http://www.sphinx-doc.org/en/master/config
8-
9-
# -- Path setup --------------------------------------------------------------
10-
11-
# If extensions (or modules to document with autodoc) are in another directory,
12-
# add these directories to sys.path here. If the directory is relative to the
13-
# documentation root, use os.path.abspath to make it absolute, like shown here.
14-
#
15-
# import os
16-
# import sys
17-
# sys.path.insert(0, os.path.abspath('.'))
18-
19-
201
# -- Project information -----------------------------------------------------
212

223
project = "Sphinx Thebe"
@@ -100,6 +81,7 @@
10081
"use_repository_button": True,
10182
"use_issues_button": True,
10283
"launch_buttons": {"thebelab": True},
84+
"navigation_with_keys": False, # To prevent an unnecessary warning
10385
}
10486

10587
# CopyButton configuration

‎pyproject.toml‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
[build-system]
2+
requires = ["hatchling", "hatch-vcs"]
3+
build-backend = "hatchling.build"
4+
5+
[project]
6+
name = "sphinx-thebe"
7+
authors = [
8+
{ name = "Executable Books Team", email = "executablebooks@gmail.com" },
9+
]
10+
maintainers = [
11+
# TODO: Add an actual maintainer
12+
{ name = "Executable Books Team", email = "executablebooks@gmail.com" },
13+
]
14+
description = "Integrate interactive code blocks into your documentation with Thebe and Binder."
15+
readme = "README.md"
16+
license = "MIT"
17+
license-files = { paths = ["LICENSE"] }
18+
requires-python = ">=3.8"
19+
classifiers = [
20+
"Development Status :: 4 - Beta",
21+
"Framework :: Sphinx :: Extension",
22+
"Intended Audience :: Developers",
23+
"Programming Language :: Python :: 3",
24+
"Programming Language :: Python :: 3 :: Only",
25+
"Programming Language :: Python :: 3.8",
26+
"Programming Language :: Python :: 3.9",
27+
"Programming Language :: Python :: 3.10",
28+
"Programming Language :: Python :: 3.11",
29+
"Programming Language :: Python :: Implementation :: CPython",
30+
"Programming Language :: Python :: Implementation :: PyPy",
31+
"Topic :: Software Development :: Libraries :: Python Modules",
32+
]
33+
dynamic = ["version"]
34+
keywords = [
35+
"development",
36+
"docutils",
37+
"sphinx",
38+
]
39+
dependencies = [
40+
"sphinx>=4",
41+
]
42+
43+
[project.urls]
44+
Homepage = "https://github.com/packit/packit"
45+
46+
[project.optional-dependencies]
47+
sphinx = [
48+
"myst-nb",
49+
"sphinx-book-theme",
50+
"sphinx-copybutton",
51+
"sphinx-design",
52+
]
53+
testing = [
54+
"myst-nb>=1.0.0rc0",
55+
"sphinx-copybutton",
56+
"sphinx-design",
57+
"matplotlib",
58+
"pytest",
59+
"pytest-regressions",
60+
"beautifulsoup4",
61+
]
62+
# TODO: Add pre-commits
63+
dev = [
64+
"sphinx-thebe[testing]",
65+
]
66+
67+
[tool.hatch]
68+
version.source = "vcs"
69+
build.hooks.vcs.version-file = "src/sphinx_thebe/_version.py"
70+
71+
[tool.pytest.ini_options]
72+
testpaths = [
73+
"tests",
74+
]

‎readthedocs.yml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
version: 2
2+
build:
3+
os: "ubuntu-22.04"
4+
tools:
5+
python: "3.12"
26
python:
3-
version: 3
47
install:
58
- method: pip
69
path: .

‎setup.cfg‎

Lines changed: 0 additions & 2 deletions
This file was deleted.

0 commit comments

Comments
 (0)