Move documenation to MyST. (#232)

Author: tobiasraabe

.github/workflows/continuous-integration-workflow.yml renamed to .github/workflows/main.yml

@@ -1,4 +1,4 @@
-name: Continuous Integration Workflow
+name: main
 
 # Automatically cancel a previous run.
 concurrency:
@@ -41,7 +41,7 @@ jobs:
 
       - name: Run unit tests and doctests.
         shell: bash -l {0}
-        run: tox -e pytest -- src tests -m "unit or (not integration and not end_to_end)" --cov=./ --cov-report=xml -n auto
+        run: tox -e pytest -- src tests -m "unit or (not integration and not end_to_end)" --cov=./ --cov-report=xml
 
       - name: Upload coverage report for unit tests and doctests.
         if: runner.os == 'Linux' && matrix.python-version == '3.8'
@@ -50,7 +50,7 @@ jobs:
 
       - name: Run integration tests.
         shell: bash -l {0}
-        run: tox -e pytest -- src tests -m integration --cov=./ --cov-report=xml -n auto
+        run: tox -e pytest -- src tests -m integration --cov=./ --cov-report=xml
 
       - name: Upload coverage reports of integration tests.
         if: runner.os == 'Linux' && matrix.python-version == '3.8'
@@ -59,7 +59,7 @@ jobs:
 
       - name: Run end-to-end tests.
         shell: bash -l {0}
-        run: tox -e pytest -- src tests -m end_to_end --cov=./ --cov-report=xml -n auto
+        run: tox -e pytest -- src tests -m end_to_end --cov=./ --cov-report=xml
 
       - name: Upload coverage reports of end-to-end tests.
         if: runner.os == 'Linux' && matrix.python-version == '3.8'

.pre-commit-config.yaml

@@ -47,11 +47,6 @@ repos:
     rev: 22.1.0
     hooks:
     -   id: black
--   repo: https://github.com/asottile/blacken-docs
-    rev: v1.12.1
-    hooks:
-    -   id: blacken-docs
-        additional_dependencies: [black]
 -   repo: https://github.com/PyCQA/flake8
     rev: 4.0.1
     hooks:
@@ -76,6 +71,11 @@ repos:
     rev: 0.10.1
     hooks:
     -   id: doc8
+-   repo: https://github.com/asottile/blacken-docs
+    rev: v1.12.1
+    hooks:
+    -   id: blacken-docs
+        additional_dependencies: [black==22.1.0]
 -   repo: https://github.com/econchick/interrogate
     rev: 1.5.0
     hooks:

README.rst

@@ -29,7 +29,7 @@
 .. image:: https://readthedocs.org/projects/pytask-dev/badge/?version=latest
     :target: https://pytask-dev.readthedocs.io/en/stable
 
-.. image:: https://img.shields.io/github/workflow/status/pytask-dev/pytask/Continuous%20Integration%20Workflow/main
+.. image:: https://img.shields.io/github/workflow/status/pytask-dev/pytask/main/main
    :target: https://github.com/pytask-dev/pytask/actions?query=branch%3Amain
 
 .. image:: https://codecov.io/gh/pytask-dev/pytask/branch/main/graph/badge.svg
@@ -60,13 +60,13 @@ projects. Its features include:
   <https://pytask-dev.readthedocs.io/en/stable/tutorials/how_to_debug.html>`_ if a task
   fails, get feedback quickly, and be more productive.
 
-- **Parametrizations via loops.** `Loop over task functions
-  <https://pytask-dev.readthedocs.io/en/stable/tutorials/how_to_parametrize_a_task.html>`_
+- **Repeat a task with different inputs.** `Loop over task functions
+  <https://pytask-dev.readthedocs.io/en/stable/tutorials/repeating_tasks_with_different_inputs.html>`_
   to run the same task with different inputs.
 
 - **Select tasks via expressions.** Run only a subset of tasks with `expressions and
   marker expressions
-  <https://pytask-dev.readthedocs.io/en/stable/tutorials/how_to_select_tasks.html>`_
+  <https://pytask-dev.readthedocs.io/en/stable/tutorials/selecting_tasks.html>`_
   known from pytest.
 
 - **Easily extensible with plugins**. pytask is built on top of `pluggy

docs/rtd_environment.yml

@@ -12,6 +12,7 @@ dependencies:
   - furo
   - ipython
   - nbsphinx
+  - myst-parser
   - sphinx
   - sphinx-autoapi
   - sphinx-click
@@ -32,3 +33,4 @@ dependencies:
 
   - pip:
     - ../
+    - sphinxext-opengraph

docs/source/api.rst renamed to docs/source/api.md

@@ -1,11 +1,12 @@
-API Reference
-=============
+# API Reference
 
 The following documents are auto-generated and not carefully edited. They provide direct
 access to the source code and the docstrings.
 
-.. toctree::
-   :titlesonly:
-
-   /autoapi/pytask/index
-   /autoapi/_pytask/index
+```{toctree}
+---
+titlesonly: true
+---
+/autoapi/pytask/index
+/autoapi/_pytask/index
+```