From eed6aafbb19935c0b4e614b36f5f893f41fe3e87 Mon Sep 17 00:00:00 2001 From: Yuri Bochkarev Date: Mon, 16 Dec 2019 21:46:23 +0100 Subject: [PATCH] remove doc update step from CONTRIBUTING.md, use markdown in setup.py --- CONTRIBUTING.md | 6 ++---- setup.py | 6 +++--- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0eca116..4041165 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -237,10 +237,8 @@ DRAFT `git add ... & git ci -m 'Bump version (old_version -> new_version)'` 4. `git tag new_version` 5. `git push && git push --tags` -6. `pandoc --from=markdown --to=rst --output=README.rst README.md`. - I think this is required for PyPI description to look nice. -7. `python setup.py sdist bdist_wheel --universal` to build the package -8. `twine upload dist/coursera-dl-0.6.1.tar.gz` to deploy the package. +6. `python setup.py sdist bdist_wheel --universal` to build the package +7. `twine upload dist/coursera-dl-0.6.1.tar.gz` to deploy the package. ## Docker diff --git a/setup.py b/setup.py index 9dffac9..bdac4f1 100644 --- a/setup.py +++ b/setup.py @@ -60,9 +60,8 @@ def read_file(filename, alt=None): generate_readme_rst() long_description = read_file( - 'README.rst', - 'Generate README.rst from README.md via pandoc!\n\nExample: ' - 'pandoc --from=markdown --to=rst --output=README.rst README.md' + 'README.md', + 'Cannot read README.md' ) requirements = read_file('requirements.txt') dev_requirements = read_file('requirements-dev.txt') @@ -101,6 +100,7 @@ setup( description='Script for downloading Coursera.org videos and naming them.', long_description=long_description, + long_description_content_type='text/markdown', keywords=['coursera-dl', 'coursera', 'download', 'education', 'MOOCs', 'video'], classifiers=trove_classifiers,