Align pytask-latex with pytask v0.2. (#33)

pytask-dev · Apr 16, 2022 · bbed260 · bbed260
1 parent 32870a1
commit bbed260
Show file tree

Hide file tree

Showing 32 changed files with 1,154 additions and 880 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,24 +1,21 @@
----
+______________________________________________________________________
 
-name: Bug Report
-about: Create a bug report to help us improve pytask-latex
-title: "BUG:"
-labels: "bug"
+name: Bug Report about: Create a bug report to help us improve pytask-latex title:
+"BUG:" labels: "bug"
 
----
+______________________________________________________________________
 
 - [ ] I have checked that this issue has not already been reported.
 
 - [ ] I have confirmed this bug exists on the latest version of pytask-latex.
 
-- [ ] (optional) I have confirmed this bug exists on the `main` branch of
-  pytask-latex.
+- [ ] (optional) I have confirmed this bug exists on the `main` branch of pytask-latex.
 
----
+______________________________________________________________________
 
-**Note**: Please read [this
-guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing
-how to provide the necessary information for us to reproduce your bug.
+**Note**: Please read
+[this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
+detailing how to provide the necessary information for us to reproduce your bug.
 
 #### Code Sample, a copy-pastable example
 

diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
@@ -1,11 +1,9 @@
----
+______________________________________________________________________
 
-name: Documentation Improvement
-about: Report wrong or missing documentation
-title: "DOC:"
-labels: "documentation"
+name: Documentation Improvement about: Report wrong or missing documentation title:
+"DOC:" labels: "documentation"
 
----
+______________________________________________________________________
 
 #### Location of the documentation
 

diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md
@@ -1,16 +1,14 @@
----
+______________________________________________________________________
 
-name: Enhancement
-about: Suggest an idea for pytask-latex
-title: "ENH:"
-labels: "enhancement"
+name: Enhancement about: Suggest an idea for pytask-latex title: "ENH:" labels:
+"enhancement"
 
----
+______________________________________________________________________
 
 #### Is your feature request related to a problem?
 
-Provide a description of what the problem is, e.g. "I wish I could use pytask-latex
-to do [...]".
+Provide a description of what the problem is, e.g. "I wish I could use pytask-latex to
+do \[...\]".
 
 #### Describe the solution you'd like
 

diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
@@ -1,17 +1,15 @@
----
+______________________________________________________________________
 
-name: Submit Question
-about: Ask a general question about pytask-latex
-title: "QST:"
+name: Submit Question about: Ask a general question about pytask-latex title: "QST:"
 labels: "question"
 
----
+______________________________________________________________________
 
 #### Question about pytask-latex
 
-**Note**: If you'd still like to submit a question, please read [this guide](
-https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing how to
-provide the necessary information for us to reproduce your question.
+**Note**: If you'd still like to submit a question, please read
+[this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
+detailing how to provide the necessary information for us to reproduce your question.
 
 ```python
 # Your code here, if applicable

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -6,4 +6,4 @@ Provide a description and/or bullet points to describe the changes in this PR.
 
 - [ ] Reference issues which can be closed due to this PR with "Closes #x".
 - [ ] Review whether the documentation needs to be updated.
-- [ ] Document PR in docs/changes.rst.
+- [ ] Document PR in CHANGES.md.
diff --git a/...flows/continuous-integration-workflow.yml → .github/workflows/main.yml b/...flows/continuous-integration-workflow.yml → .github/workflows/main.yml
@@ -1,4 +1,4 @@
-name: Continuous Integration Workflow
+name: main
 
 # Automatically cancel a previous run.
 concurrency:

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -24,9 +24,6 @@ repos:
     -   id: python-no-eval
     -   id: python-no-log-warn
     -   id: python-use-type-annotations
-    -   id: rst-backticks
-    -   id: rst-directive-colons
-    -   id: rst-inline-touching-normal
     -   id: text-unicode-replacement-char
 -   repo: https://github.com/asottile/pyupgrade
     rev: v2.32.0
@@ -72,15 +69,20 @@ repos:
             pydocstyle,
             Pygments,
         ]
--   repo: https://github.com/PyCQA/doc8
-    rev: 0.11.1
-    hooks:
-    -   id: doc8
 -   repo: https://github.com/econchick/interrogate
     rev: 1.5.0
     hooks:
     -   id: interrogate
         args: [-v, --fail-under=40, src, tests]
+-   repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.14
+    hooks:
+    -   id: mdformat
+        additional_dependencies: [
+            mdformat-gfm,
+            mdformat-black,
+        ]
+        args: [--wrap, "88"]
 - repo: https://github.com/codespell-project/codespell
   rev: v2.1.0
   hooks:
@@ -90,6 +92,8 @@ repos:
     rev: "0.48"
     hooks:
     -   id: check-manifest
+        args: [--no-build-isolation]
+        additional_dependencies: [setuptools-scm, toml]
 -   repo: meta
     hooks:
     -   id: check-hooks-apply

diff --git a/CHANGES.md b/CHANGES.md
@@ -0,0 +1,88 @@
+# Changes
+
+This is a record of all past pytask-latex releases and what went into them in reverse
+chronological order. Releases follow [semantic versioning](https://semver.org/) and all
+releases are available on [Anaconda.org](https://anaconda.org/conda-forge/pytask-latex).
+
+## 0.2.0 - 2022-04-16
+
+- {pull}`33` aligns pytask-latex with the pytask v0.2.
+- {pull}`34` deprecates the old api.
+
+## 0.1.2 - 2022-03-26
+
+- {pull}`32` implements a new interface to the compilation process which consists of
+  composable compilation steps. (Many thanks to `axtimhaus`{.interpreted-text
+  role="user"}!:tada:)
+- {pull}`36` fixes some issues.
+- {pull}`37` updates the release notes.
+
+## 0.1.1 - 2022-02-08
+
+- {pull}`30` skips concurrent CI builds.
+- {pull}`31` deprecates Python 3.6 and add support for Python 3.10.
+
+## 0.1.0 - 2021-07-21
+
+- {pull}`23` updates the `README.rst`.
+- {pull}`24` replaces versioneer with setuptools-scm.
+- {pull}`26` aligns pytask-latex with pytask v0.1.0.
+
+## 0.0.12 - 2021-03-05
+
+- {pull}`19` fixes some post-release issues.
+- {pull}`21` adds dependencies to `setup.py` and install via `conda-forge`.
+
+## 0.0.11 - 2021-02-25
+
+- {pull}`18` prepares pytask-latex to be published on PyPI, adds versioneer and more.
+
+## 0.0.10 - 2021-01-16
+
+- {pull}`16` fixes the scanner by keeping only scanned dependencies which exist. Convert
+  args to strings.
+
+## 0.0.9 - 2020-12-28
+
+- {pull}`12` integrates the latex-dependency-scanner to automatically detect
+  dependencies of a LaTeX document and releases v0.0.9.
+- {pull}`13` fixes the CI.
+
+## 0.0.8 - 2020-10-29
+
+- {pull}`11` makes pytask-latex work with pytask v0.0.9.
+
+## 0.0.7 - 2020-10-14
+
+- {pull}`10` fixes error that `outputdirectory` has to be relative to latex document due
+  to security problems.
+
+## 0.0.6 - 2020-10-14
+
+- {pull}`9` fixes the last release and the `pytask_collect_task_teardown` call.
+
+## 0.0.5 - 2020-10-04
+
+- {pull}`5` fixes some errors in the test suite due to pytask v0.0.6.
+- {pull}`6` check that exit codes are equal to zero.
+- {pull}`7` fixes the README.
+- {pull}`8` works with pytask v0.0.7 and releases v0.0.5.
+
+## 0.0.4 - 2020-08-21
+
+- {pull}`4` changes the default options. latexmk will step into the source directory
+  before compiling the document. Releases 0.0.4.
+
+## 0.0.3 - 2020-08-12
+
+- {pull}`3` prepares pytask-latex for pytask v0.0.5 and releases v0.0.3.
+
+## 0.0.2 - 2020-07-22
+
+- {pull}`1` allowed LaTeX tasks to have more than one dependency and allows to
+  parametrize over latex options and latex documents. It also prepares release v0.0.2.
+- {pull}`2` fixes the release.
+
+## 0.0.1 - 2020-07-20
+
+- Releases v0.0.1.
diff --git a/CHANGES.rst b/CHANGES.rst
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,12 +1,9 @@
-prune .conda
 prune tests
 
-exclude *.rst
+exclude *.md
 exclude *.yml
 exclude *.yaml
 exclude tox.ini
 
-include README.rst
+include README.md
 include LICENSE
-include versioneer.py
-include src/pytask_latex/_version.py