Refactor Readme and use for long_description

Improve readme with a different structure and some link changes.

The landscape.io links have been removed as that project seems 
discontinued since April 2020.

With `long_description_content_type="text/markdown"` it is possible
to use Markdown text in the `long_description` meta-data field. Make sure
the latest tools (setuptools, wheel, twine) are installed before deploying.
This commit is contained in:
Andre_601
2021-03-29 16:22:44 +02:00
committed by GitHub
parent 41c9961de5
commit fd5a890578
2 changed files with 50 additions and 21 deletions

View File

@@ -6,12 +6,8 @@ import os
import sys
long_description = (
"MkDocs is a fast, simple and downright gorgeous static site generator "
"that's geared towards building project documentation. Documentation "
"source files are written in Markdown, and configured with a single YAML "
"configuration file."
)
with open('README.md') as f:
long_description = f.read()
def get_version(package):
@@ -49,6 +45,7 @@ setup(
license='BSD',
description='Project documentation with Markdown.',
long_description=long_description,
long_description_content_type='text/markdown',
author='Tom Christie',
author_email='tom@tomchristie.com', # SEE NOTE BELOW (*)
packages=get_packages("mkdocs"),