Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BUG,DOC: long_description fails to render with pypi #788

Closed
westurner opened this issue Jan 12, 2019 · 2 comments
Closed

BUG,DOC: long_description fails to render with pypi #788

westurner opened this issue Jan 12, 2019 · 2 comments

Comments

@westurner
Copy link

westurner commented Jan 12, 2019

https://pypi.org/project/buildozer/

https://github.com/pypa/readme_renderer/blob/master/README.rst#check-description-locally

You can check the long_description syntax w/:

twine check
@westurner
Copy link
Author

https://cookiecutter.readthedocs.io/en/latest/readme.html#cookiecutter-specials

https://github.com/audreyr/cookiecutter-pypackage/blob/master/%7B%7Bcookiecutter.project_slug%7D%7D/setup.py

with open('README.rst') as readme_file:
    readme = readme_file.read()

with open('HISTORY.rst') as history_file:
    history = history_file.read()

# ...
setup(
    long_description=readme + '\n\n' + history,
)

https://github.com/audreyr/cookiecutter-pypackage/blob/master/%7B%7Bcookiecutter.project_slug%7D%7D/docs/readme.rst

.. include:: ../README.rst

@AndreMiras
Copy link
Member

I believe this is fixed https://github.com/kivy/buildozer/blob/1.1.0/.github/workflows/pypi-release.yml#L19
Feel free to reopen with info otherwise.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants