pyproject.toml can't get README.rst to be accepted for long_description

[solarslurpi]

(Please forgive my ignorance. I try to follow directions but I seem to be clueless).

I am failing to get my README.rst file to be working for my long_description within the pyproject.toml file. I am unclear why (advice appreciated, thank you).

I have a pyproject.toml file:

[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"

[project]
name = "growbuddies"
version = "2022.12.0"
readme = "README.rst"
description = "Buddies to help maximize the growth of plants in your indoor garden."
dependencies = [
    "influxdb ~=5.3.1",
    "paho_mqtt ~=1.6.1",
]

[project.urls]
"Homepage" = "https://github.com/solarslurpi/GrowBuddies"

[project.scripts]
get-readings = "growbuddies.__main__:main"

The [project] tables notes readme = "README.RST". At the same directory level as pyproject.toml, I have an EMPTY README.rst file.

I run $ twine check dist/*

and get:

Checking dist/growbuddies-2022.11.28-py3-none-any.whl: FAILED
ERROR    `long_description` has syntax errors in markup and would not be rendered on PyPI.                               
         No content rendered from RST source.                                                                            
WARNING  `long_description_content_type` missing. defaulting to `text/x-rst`.                                            
Checking dist/growbuddies-2022.12.0-py3-none-any.whl: FAILED
ERROR    `long_description` has syntax errors in markup and would not be rendered on PyPI.                               
         No content rendered from RST source.                                                                            
Checking dist/growbuddies-2022.11.28.tar.gz: PASSED with warnings
WARNING  `long_description_content_type` missing. defaulting to `text/x-rst`.                                            
WARNING  `long_description` missing.                                                                                     
Checking dist/growbuddies-2022.12.0.tar.gz: PASSED with warnings
WARNING  `long_description` missing.            

[solarslurpi]

I'd like to close. I think my problem is my cluelessness. When I used README.md, stuff worked. Thank you.

[abravalheri]

If I had to guess, I would say that the warning was happening because your README.rst file was empty (but I might be wrong).

I suppose that when you changed to README.md, the file had some content, right?

[solarslurpi]

Thank you for the reply. I tried both README.rst and README.md. I tried multiple times The first time README.rst had content. I took it out. A filled out README.md did work. So now my rule is JUST use README.md.