mirror of
https://github.com/mkdocs/mkdocs.git
synced 2026-03-27 09:58:31 +07:00
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:
9
setup.py
9
setup.py
@@ -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"),
|
||||
|
||||
Reference in New Issue
Block a user