refactor(docs): move from reST to markdown (#123)

Convert docs from reStructuredText to markdown so that the changelog
file is compatible with `release-please`.

AUTHORS.md

@@ -0,0 +1,13 @@
+# Authors
+
+The list of contributors in alphabetical order:
+
+- [Audrius Mecionis](https://orcid.org/0000-0002-3759-1663)
+- [Camila Diaz](https://orcid.org/0000-0001-5543-797X)
+- [Diego Rodriguez](https://orcid.org/0000-0003-0649-2002)
+- [Dinos Kousidis](https://orcid.org/0000-0002-4914-4289)
+- [Jan Okraska](https://orcid.org/0000-0002-1416-3244)
+- [Marco Donadoni](https://orcid.org/0000-0003-2922-5505)
+- [Marco Vidal](https://orcid.org/0000-0002-9363-4971)
+- [Rokas Maciulaitis](https://orcid.org/0000-0003-1064-6967)
+- [Tibor Simko](https://orcid.org/0000-0001-7202-5803)

CHANGELOG.md

@@ -0,0 +1,75 @@
+# Changelog
+
+## 0.9.2 (2023-11-30)
+
+- Changes CI to use the stable release of Python 3.12.
+
+## 0.9.1 (2023-09-26)
+
+- Adds support for Python 3.12.
+- Changes `apispec` dependency version in order to be compatible with `PyYAML` v6.
+- Fixes container image fixtures to be Podman-compatible.
+- Fixes Kombu documentation linking.
+
+## 0.9.0 (2022-12-13)
+
+- Adds fixture providing example of user secrets needed for Kerberos tests.
+- Adds support for Python 3.11.
+- Fixes location of Celery docs for ReadTheDocs pages.
+- Removes hard-dependency on `black` code formatter version.
+
+## 0.8.1 (2022-01-05)
+
+- Adds support for Python 3.10.
+
+## 0.8.0 (2021-11-22)
+
+- Adds nested Yadage workflow specification fixture.
+- Adds empty workflow workspaces for sample workflows by default.
+- Adds internal representation of a scatter-gather Snakemake workflow fixture.
+- Changes `tmp_shared_volume_path` fixture to be configurable through environment variable.
+- Changes fixtures to run with the full workspace path stored in the database.
+- Removes support for Python 2.
+
+## 0.7.2 (2021-07-02)
+
+- Changes internal dependencies to remove click.
+
+## 0.7.1 (2021-03-17)
+
+- Adds support for Python 3.9.
+- Fixes minor code warnings.
+- Fixes installation by upgrading REANA-DB version.
+
+## 0.7.0 (2020-10-20)
+
+- Adds new `__reana` database schema for `db` fixture.
+- Fixes a problem related to duplicated database session.
+- Changes code formatting to respect `black` coding style.
+- Changes documentation to single-page layout.
+
+## 0.6.0 (2019-12-19)
+
+- Adds fixtures for secrets store.
+- Centralises test requirements.
+- Adds Python 3.8 support.
+
+## 0.5.0 (2019-04-16)
+
+- Makes workspace path configurable for the `sample_workflow_workspace`
+  fixture through the `path` parameter.
+- Adds `sample_serial_workflow_in_db` fixture.
+- Exposes previously hidden `sample_yadage_workflow_in_db` fixture.
+- Adds missing database session close in `session` fixture.
+- Adds helpers to represent starting and requeueing job conditions,
+  `sample_condition_for_starting_queued_workflows` and
+  `sample_condition_for_requeueing_workflows`.
+
+## 0.4.1 (2018-11-06)
+
+- Adds directory including sample workspace data.
+
+## 0.4.0 (2018-11-06)
+
+- Initial public release.
+

CONTRIBUTING.rst → CONTRIBUTING.md

@@ -1,20 +1,18 @@
-Contributing
-============
+# Contributing
 
 Bug reports, issues, feature requests, and other contributions are welcome. If you find
 a demonstrable problem that is caused by the REANA code, please:
 
-1. Search for `already reported problems
-   <https://github.com/reanahub/pytest-reana/issues>`_.
+1. Search for [already reported problems](https://github.com/reanahub/pytest-reana/issues).
 2. Check if the issue has been fixed or is still reproducible on the
    latest `master` branch.
 3. Create an issue, ideally with **a test case**.
 
 If you create a pull request fixing a bug or implementing a feature, you can run
 the tests to ensure that everything is operating correctly:
 
-.. code-block:: console
-
-    $ ./run-tests.sh
+```console
+$ ./run-tests.sh
+```
 
 Each pull request should preserve or increase code coverage.

MANIFEST.in

@@ -21,6 +21,7 @@ prune docs/_build
 recursive-include docs *.png
 recursive-include docs *.py
 recursive-include docs *.rst
+recursive-include docs *.md
 recursive-include docs *.txt
 recursive-include pytest_reana *.csv
 recursive-include pytest_reana *.ipynb

README.md

@@ -0,0 +1,40 @@
+# pytest-REANA
+
+[![image](https://img.shields.io/pypi/pyversions/pytest-reana.svg)](https://pypi.org/pypi/pytest-reana)
+[![image](https://github.com/reanahub/pytest-reana/workflows/CI/badge.svg)](https://github.com/reanahub/pytest-reana/actions)
+[![image](https://readthedocs.org/projects/pytest-reana/badge/?version=latest)](https://pytest-reana.readthedocs.io/en/latest/?badge=latest)
+[![image](https://codecov.io/gh/reanahub/pytest-reana/branch/master/graph/badge.svg)](https://codecov.io/gh/reanahub/pytest-reana)
+[![image](https://img.shields.io/badge/discourse-forum-blue.svg)](https://forum.reana.io)
+[![image](https://img.shields.io/github/license/reanahub/pytest-reana.svg)](https://github.com/reanahub/pytest-reana/blob/master/LICENSE)
+[![image](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+## About
+
+pytest-REANA is a component of the [REANA](http://www.reana.io/) reusable and
+reproducible research data analysis platform. It provides pytest fixtures and test
+utilities.
+
+## Features
+
+- pytest fixtures
+- mocking OpenAPI client with request format validation
+- mocking Advanced Message Queuing Protocol consumers and producers
+- mocking Celery tasks
+- mocking file system workspace access
+- mocking database access
+- includes sample workspace directory
+
+## Usage
+
+The detailed information on how to install and use REANA can be found in
+[docs.reana.io](https://docs.reana.io).
+
+## Useful links
+
+- [REANA project home page](http://www.reana.io/)
+- [REANA user documentation](https://docs.reana.io)
+- [REANA user support forum](https://forum.reana.io)
+- [pytest-REANA releases](https://pytest-reana.readthedocs.io/en/latest#changes)
+- [pytest-REANA developer documentation](https://pytest-reana.readthedocs.io/)
+- [pytest-REANA known issues](https://github.com/reanahub/pytest-reana/issues)
+- [pytest-REANA source code](https://github.com/reanahub/pytest-reana)

docs/conf.py

@@ -33,6 +33,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    "myst_parser",
     "sphinx.ext.autodoc",
     "sphinx.ext.coverage",
     "sphinx.ext.doctest",
@@ -48,7 +49,10 @@
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = ".rst"
+source_suffix = [".rst", ".md"]
+
+# Allow using ::: in markdown files
+myst_enable_extensions = ["colon_fence"]
 
 # The master toctree document.
 master_doc = "index"