adds pandoc dependency to build rst from README.md

.github/workflows/documentation.yml

@@ -19,6 +19,9 @@ jobs:
       - name: Install dependencies
         run: |
           poetry install
+      - name: Convert Readme to rst
+        run: |
+          poetry run pandoc ./README.md -o ./docs/README.rst
       - name: Sphinx build
         run: |
           poetry run sphinx-build ./docs ./docs/_build

docs/README.rst

@@ -1,8 +1,6 @@
 LabLib
 ======
 
-|image1|
-
 Generate intermediate sequences for VFX processing using OIIO and
 FFMPEG!
 
@@ -15,6 +13,9 @@ FFMPEG matrix values to be used in filters for repositioning. - Create
 correctly formed OIIO commandline strings automatically. - Render out
 frames with Color and Repositioning baked in using oiiotool
 
+**DISCLAIMER** This is still a wip, and it’s currently missing a lot of
+functionality. Use at your own risk!
+
 Instructions
 ------------
 
@@ -61,4 +62,10 @@ You can run the full suite with ``.\start.ps1 test`` or to run custom
 ``pytest`` commands make sure to be in the cloned repository’s directory
 and run ``poetry run pytest [ARGS]``.
 
-.. |image1| image:: https://img.shields.io/badge/os-windows-blue
+Contributing
+------------
+
+The best way to contribute to LabLib currently is to write extensive
+test cases for all modules. But also sharing your thoughts and ideas on
+the `Discussions Page <https://github.com/ynput/LabLib/discussions>`__
+really helps to keep this project going 💞

pyproject.toml

@@ -20,6 +20,7 @@ sphinx-autoapi = "^2.0.1"
 sphinxcontrib-napoleon = "^0.7"
 revitron-sphinx-theme = { git = "https://github.com/revitron/revitron-sphinx-theme.git", branch = "master" }
 furo = "^2024.5.6"
+pandoc = "^2.3"
 
 [tool.poetry.extras]
 docs = ["Sphinx", "sphinxcontrib-napoleon"]