Skip to content

Commit bbed260

Browse files
tobiasraabetobiasraabe
authored
Align pytask-latex with pytask v0.2. (#33)
1 parent 32870a1 commit bbed260

32 files changed

+1154
-880
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+9-12
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,21 @@
1-
---
1+
______________________________________________________________________
22

3-
name: Bug Report
4-
about: Create a bug report to help us improve pytask-latex
5-
title: "BUG:"
6-
labels: "bug"
3+
name: Bug Report about: Create a bug report to help us improve pytask-latex title:
4+
"BUG:" labels: "bug"
75

8-
---
6+
______________________________________________________________________
97

108
- [ ] I have checked that this issue has not already been reported.
119

1210
- [ ] I have confirmed this bug exists on the latest version of pytask-latex.
1311

14-
- [ ] (optional) I have confirmed this bug exists on the `main` branch of
15-
pytask-latex.
12+
- [ ] (optional) I have confirmed this bug exists on the `main` branch of pytask-latex.
1613

17-
---
14+
______________________________________________________________________
1815

19-
**Note**: Please read [this
20-
guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing
21-
how to provide the necessary information for us to reproduce your bug.
16+
**Note**: Please read
17+
[this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
18+
detailing how to provide the necessary information for us to reproduce your bug.
2219

2320
#### Code Sample, a copy-pastable example
2421

‎.github/ISSUE_TEMPLATE/documentation.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
---
1+
______________________________________________________________________
22

3-
name: Documentation Improvement
4-
about: Report wrong or missing documentation
5-
title: "DOC:"
6-
labels: "documentation"
3+
name: Documentation Improvement about: Report wrong or missing documentation title:
4+
"DOC:" labels: "documentation"
75

8-
---
6+
______________________________________________________________________
97

108
#### Location of the documentation
119

‎.github/ISSUE_TEMPLATE/enhancement.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
1-
---
1+
______________________________________________________________________
22

3-
name: Enhancement
4-
about: Suggest an idea for pytask-latex
5-
title: "ENH:"
6-
labels: "enhancement"
3+
name: Enhancement about: Suggest an idea for pytask-latex title: "ENH:" labels:
4+
"enhancement"
75

8-
---
6+
______________________________________________________________________
97

108
#### Is your feature request related to a problem?
119

12-
Provide a description of what the problem is, e.g. "I wish I could use pytask-latex
13-
to do [...]".
10+
Provide a description of what the problem is, e.g. "I wish I could use pytask-latex to
11+
do \[...\]".
1412

1513
#### Describe the solution you'd like
1614

‎.github/ISSUE_TEMPLATE/question.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
1-
---
1+
______________________________________________________________________
22

3-
name: Submit Question
4-
about: Ask a general question about pytask-latex
5-
title: "QST:"
3+
name: Submit Question about: Ask a general question about pytask-latex title: "QST:"
64
labels: "question"
75

8-
---
6+
______________________________________________________________________
97

108
#### Question about pytask-latex
119

12-
**Note**: If you'd still like to submit a question, please read [this guide](
13-
https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing how to
14-
provide the necessary information for us to reproduce your question.
10+
**Note**: If you'd still like to submit a question, please read
11+
[this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
12+
detailing how to provide the necessary information for us to reproduce your question.
1513

1614
```python
1715
# Your code here, if applicable

‎.github/pull_request_template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ Provide a description and/or bullet points to describe the changes in this PR.
66

77
- [ ] Reference issues which can be closed due to this PR with "Closes #x".
88
- [ ] Review whether the documentation needs to be updated.
9-
- [ ] Document PR in docs/changes.rst.
9+
- [ ] Document PR in CHANGES.md.

‎.github/workflows/continuous-integration-workflow.yml ‎.github/workflows/main.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Continuous Integration Workflow
1+
name: main
22

33
# Automatically cancel a previous run.
44
concurrency:

‎.pre-commit-config.yaml

+11-7
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,6 @@ repos:
2424
- id: python-no-eval
2525
- id: python-no-log-warn
2626
- id: python-use-type-annotations
27-
- id: rst-backticks
28-
- id: rst-directive-colons
29-
- id: rst-inline-touching-normal
3027
- id: text-unicode-replacement-char
3128
- repo: https://github.com/asottile/pyupgrade
3229
rev: v2.32.0
@@ -72,15 +69,20 @@ repos:
7269
pydocstyle,
7370
Pygments,
7471
]
75-
- repo: https://github.com/PyCQA/doc8
76-
rev: 0.11.1
77-
hooks:
78-
- id: doc8
7972
- repo: https://github.com/econchick/interrogate
8073
rev: 1.5.0
8174
hooks:
8275
- id: interrogate
8376
args: [-v, --fail-under=40, src, tests]
77+
- repo: https://github.com/executablebooks/mdformat
78+
rev: 0.7.14
79+
hooks:
80+
- id: mdformat
81+
additional_dependencies: [
82+
mdformat-gfm,
83+
mdformat-black,
84+
]
85+
args: [--wrap, "88"]
8486
- repo: https://github.com/codespell-project/codespell
8587
rev: v2.1.0
8688
hooks:
@@ -90,6 +92,8 @@ repos:
9092
rev: "0.48"
9193
hooks:
9294
- id: check-manifest
95+
args: [--no-build-isolation]
96+
additional_dependencies: [setuptools-scm, toml]
9397
- repo: meta
9498
hooks:
9599
- id: check-hooks-apply

‎CHANGES.md

+88
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# Changes
2+
3+
This is a record of all past pytask-latex releases and what went into them in reverse
4+
chronological order. Releases follow [semantic versioning](https://semver.org/) and all
5+
releases are available on [Anaconda.org](https://anaconda.org/conda-forge/pytask-latex).
6+
7+
## 0.2.0 - 2022-04-16
8+
9+
- {pull}`33` aligns pytask-latex with the pytask v0.2.
10+
- {pull}`34` deprecates the old api.
11+
12+
## 0.1.2 - 2022-03-26
13+
14+
- {pull}`32` implements a new interface to the compilation process which consists of
15+
composable compilation steps. (Many thanks to `axtimhaus`{.interpreted-text
16+
role="user"}!:tada:)
17+
- {pull}`36` fixes some issues.
18+
- {pull}`37` updates the release notes.
19+
20+
## 0.1.1 - 2022-02-08
21+
22+
- {pull}`30` skips concurrent CI builds.
23+
- {pull}`31` deprecates Python 3.6 and add support for Python 3.10.
24+
25+
## 0.1.0 - 2021-07-21
26+
27+
- {pull}`23` updates the `README.rst`.
28+
- {pull}`24` replaces versioneer with setuptools-scm.
29+
- {pull}`26` aligns pytask-latex with pytask v0.1.0.
30+
31+
## 0.0.12 - 2021-03-05
32+
33+
- {pull}`19` fixes some post-release issues.
34+
- {pull}`21` adds dependencies to `setup.py` and install via `conda-forge`.
35+
36+
## 0.0.11 - 2021-02-25
37+
38+
- {pull}`18` prepares pytask-latex to be published on PyPI, adds versioneer and more.
39+
40+
## 0.0.10 - 2021-01-16
41+
42+
- {pull}`16` fixes the scanner by keeping only scanned dependencies which exist. Convert
43+
args to strings.
44+
45+
## 0.0.9 - 2020-12-28
46+
47+
- {pull}`12` integrates the latex-dependency-scanner to automatically detect
48+
dependencies of a LaTeX document and releases v0.0.9.
49+
- {pull}`13` fixes the CI.
50+
51+
## 0.0.8 - 2020-10-29
52+
53+
- {pull}`11` makes pytask-latex work with pytask v0.0.9.
54+
55+
## 0.0.7 - 2020-10-14
56+
57+
- {pull}`10` fixes error that `outputdirectory` has to be relative to latex document due
58+
to security problems.
59+
60+
## 0.0.6 - 2020-10-14
61+
62+
- {pull}`9` fixes the last release and the `pytask_collect_task_teardown` call.
63+
64+
## 0.0.5 - 2020-10-04
65+
66+
- {pull}`5` fixes some errors in the test suite due to pytask v0.0.6.
67+
- {pull}`6` check that exit codes are equal to zero.
68+
- {pull}`7` fixes the README.
69+
- {pull}`8` works with pytask v0.0.7 and releases v0.0.5.
70+
71+
## 0.0.4 - 2020-08-21
72+
73+
- {pull}`4` changes the default options. latexmk will step into the source directory
74+
before compiling the document. Releases 0.0.4.
75+
76+
## 0.0.3 - 2020-08-12
77+
78+
- {pull}`3` prepares pytask-latex for pytask v0.0.5 and releases v0.0.3.
79+
80+
## 0.0.2 - 2020-07-22
81+
82+
- {pull}`1` allowed LaTeX tasks to have more than one dependency and allows to
83+
parametrize over latex options and latex documents. It also prepares release v0.0.2.
84+
- {pull}`2` fixes the release.
85+
86+
## 0.0.1 - 2020-07-20
87+
88+
- Releases v0.0.1.

‎CHANGES.rst

-120
This file was deleted.

‎MANIFEST.in

+2-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
1-
prune .conda
21
prune tests
32

4-
exclude *.rst
3+
exclude *.md
54
exclude *.yml
65
exclude *.yaml
76
exclude tox.ini
87

9-
include README.rst
8+
include README.md
109
include LICENSE
11-
include versioneer.py
12-
include src/pytask_latex/_version.py

0 commit comments

Comments
 (0)