Switch to rst as various local checks of bad markdown yielded no failures

Author: ArBridgeman

README.md

@@ -0,0 +1,62 @@
+Exasol Toolbox
+==============
+
+Your one-stop solution for managing all standard tasks and core workflows of your Python project.
+
+.. image:: https://github.com/exasol/python-toolbox/actions/workflows/ci.yml/badge.svg?branch=main
+   :target: https://github.com/exasol/python-toolbox/actions/workflows/ci.yml
+   :alt: Checks Main
+
+.. image:: https://img.shields.io/pypi/l/exasol-toolbox
+   :target: https://opensource.org/licenses/MIT
+   :alt: License
+
+.. image:: https://img.shields.io/pypi/dm/exasol-toolbox
+   :target: https://pypi.org/project/exasol-toolbox/
+   :alt: Downloads
+
+.. image:: https://img.shields.io/pypi/pyversions/exasol-toolbox
+   :target: https://pypi.org/project/exasol-toolbox/
+   :alt: Supported Python Versions
+
+.. image:: https://img.shields.io/pypi/v/exasol-toolbox
+   :target: https://pypi.org/project/exasol-toolbox/
+   :alt: PyPi Package
+
+🚀 Features
+-----------
+
+- Centrally managed standard tasks:
+  - code formatting & upgrading
+  - linting
+  - type-checking
+  - unit-tests
+  - integration-tests
+  - coverage
+  - documentation
+
+- Centrally managed core workflows:
+  - workspace/project verification
+  - build and publish releases
+  - build and publish documentation
+
+- Configurable & Extensible:
+  - Project configuration
+  - Event hooks
+
+🔌️ Prerequisites
+-----------------
+
+- `Python <https://www.python.org/>`__ >= 3.9
+
+💾 Installation
+---------------
+
+.. code-block:: shell
+
+    pip install exasol-toolbox
+
+📚 Documentation
+----------------
+
+For further details, check out the latest `documentation <https://exasol.github.io/python-toolbox/>`_.

README.rst

@@ -181,6 +181,9 @@ def import_lint(session: Session) -> None:
 
 @nox.session(name="lint:build-packages", python=False)
 def dist_check(session: Session) -> None:
-    """Checks whether your distribution’s long description will render correctly on PyPI"""
-    session.run("poetry", "build")
-    session.run("twine", "check", "./dist/*")
+    """Checks whether your distribution’s long description will render correctly on PyPI
+
+    This has more robust checks for rst documentation than markdown.
+    """
+    session.run("poetry", "build", "--project", PROJECT_CONFIG.root)
+    session.run("twine", "check", PROJECT_CONFIG.root / "./dist/*")

exasol/toolbox/nox/_lint.py

@@ -7,7 +7,7 @@ authors = [
     { name = "Nicola Coretti", email = "[email protected]" },
     { name = "Ariel Schulz", email = "[email protected]" },
 ]
-readme = "README.md"
+readme = "README.rst"
 license = "MIT"
 keywords = [
     "nox",