mirror of
https://github.com/mkdocs/mkdocs.git
synced 2026-03-27 18:08:31 +07:00
ffae0ef89c
See the included documentation for a full explanation of the API.
Search has been removed and wrapped in a plugin (named "legacy_search").
The search feature was ported as-is. None of the open issues with search
have been addressed. Presumably, a new search plugin will be built from
the ground up which addresses those issues.
Note that there is no 'default' plugins. That means that users get no
search unless they enable it in the config by adding the following to
their `mkdocs.yml` file:
plugins:
- legacy_search
Fixes #206
101 lines
3.2 KiB
Python
Executable File
101 lines
3.2 KiB
Python
Executable File
#!/usr/bin/env python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
from __future__ import print_function
|
|
from setuptools import setup
|
|
import re
|
|
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."
|
|
)
|
|
|
|
|
|
def get_version(package):
|
|
"""Return package version as listed in `__version__` in `init.py`."""
|
|
init_py = open(os.path.join(package, '__init__.py')).read()
|
|
return re.search("__version__ = ['\"]([^'\"]+)['\"]", init_py).group(1)
|
|
|
|
|
|
def get_packages(package):
|
|
"""Return root package and all sub-packages."""
|
|
return [dirpath
|
|
for dirpath, dirnames, filenames in os.walk(package)
|
|
if os.path.exists(os.path.join(dirpath, '__init__.py'))]
|
|
|
|
|
|
if sys.argv[-1] == 'publish':
|
|
if os.system("pip freeze | grep wheel"):
|
|
print("wheel not installed.\nUse `pip install wheel`.\nExiting.")
|
|
sys.exit()
|
|
if os.system("pip freeze | grep twine"):
|
|
print("twine not installed.\nUse `pip install twine`.\nExiting.")
|
|
sys.exit()
|
|
os.system("python setup.py sdist bdist_wheel")
|
|
os.system("twine upload dist/*")
|
|
print("You probably want to also tag the version now:")
|
|
print(" git tag -a {0} -m 'version {0}'".format(get_version("mkdocs")))
|
|
print(" git push --tags")
|
|
sys.exit()
|
|
|
|
|
|
setup(
|
|
name="mkdocs",
|
|
version=get_version("mkdocs"),
|
|
url='http://www.mkdocs.org',
|
|
license='BSD',
|
|
description='Project documentation with Markdown.',
|
|
long_description=long_description,
|
|
author='Tom Christie',
|
|
author_email='tom@tomchristie.com', # SEE NOTE BELOW (*)
|
|
packages=get_packages("mkdocs"),
|
|
include_package_data=True,
|
|
install_requires=[
|
|
'click>=3.3',
|
|
'Jinja2>=2.7.1',
|
|
'livereload>=2.5.1',
|
|
'Markdown>=2.3.1',
|
|
'PyYAML>=3.10',
|
|
'tornado>=4.1',
|
|
],
|
|
entry_points={
|
|
'console_scripts': [
|
|
'mkdocs = mkdocs.__main__:cli',
|
|
],
|
|
'mkdocs.themes': [
|
|
'mkdocs = mkdocs.themes.mkdocs',
|
|
'readthedocs = mkdocs.themes.readthedocs',
|
|
],
|
|
'mkdocs.plugins': [
|
|
'legacy_search = mkdocs.contrib.legacy_search:SearchPlugin',
|
|
],
|
|
},
|
|
classifiers=[
|
|
'Development Status :: 5 - Production/Stable',
|
|
'Environment :: Console',
|
|
'Environment :: Web Environment',
|
|
'Intended Audience :: Developers',
|
|
'License :: OSI Approved :: BSD License',
|
|
'Operating System :: OS Independent',
|
|
'Programming Language :: Python',
|
|
'Programming Language :: Python :: 2',
|
|
'Programming Language :: Python :: 2.7',
|
|
'Programming Language :: Python :: 3',
|
|
'Programming Language :: Python :: 3.3',
|
|
'Programming Language :: Python :: 3.4',
|
|
'Programming Language :: Python :: 3.5',
|
|
"Programming Language :: Python :: Implementation :: CPython",
|
|
'Topic :: Documentation',
|
|
'Topic :: Text Processing',
|
|
],
|
|
zip_safe=False,
|
|
)
|
|
|
|
# (*) Please direct queries to the discussion group:
|
|
# https://groups.google.com/forum/#!forum/mkdocs
|