Commit Graph

35 Commits

Author SHA1 Message Date
Waylan Limberg
31e7c29784 Set 'search' as a default plugin.
Maintains better backward-compatability. Documentation updated, including
how to override the default. Also renamed the entry_point to 'search'.
The lib is still 'legacy_search'. When a new/better search plugin is
developed, the `search` entry_point will be pointed there so the default
behavior will inlcude the upgrade and a new `entry_point` will be added
('legacy_search') which points to the old plugin for those who really want
it.
2017-10-12 16:12:40 -04:00
Waylan Limberg
ffae0ef89c The Plugin API. (#1223)
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
2017-10-01 16:48:47 -04:00
Waylan Limberg
418965977f Drop support for Python 2.6.
MkDocs most likley will no longer run on Python 2.6. All relevant tests
have been removed. Closes #165.
2017-10-01 16:48:47 -04:00
Waylan Limberg
3c8a1fccca Up livereload version to >=2.5.1. (#1122)
This ensures older pyinotify versions don't break the livereload server.
Fixes #1106.
2017-01-08 17:53:08 -05:00
Dougal Matthews
cc1c9a3adb Remove external themes from MkDocs
This change removes the dependency on mkdocs-bootstrap and mkdocs-bootswatch.
It also updates all references in the code. The only remaining connection is
when a user specifies one of these themes but they are not installed they get
slightly helpful error.
2016-03-01 10:53:02 +00:00
Dougal Matthews
c1878a24a6 Add the classifier for Python 3.5 2016-01-29 17:21:25 +00:00
Dougal Matthews
71de07cdaf Lower the required Click version to 3.3 2016-01-29 17:21:12 +00:00
Dougal Matthews
bcb88abcda Rename cli.py to __main__.py
This uses the standard entrypoint name and allows `python -m mkdocs` to
work.
2015-08-13 09:26:21 +01:00
Dougal Matthews
0468754edb Add the default themes back in as packages 2015-06-27 10:40:18 +01:00
Dougal Matthews
aa7c34e3a7 Update package data discovery 2015-06-27 10:40:18 +01:00
Dougal Matthews
00f96640c4 Change the builtin themes to packages and update theme loading 2015-06-27 10:40:18 +01:00
Dougal Matthews
6a8efa580d Return the release helper
We transitioned to Travis for deploying to PyPI but this only creates a
wheel for Python 2.7. So for now, we will do the manual releases again.

This reverts commit 38fc746954.
2015-06-08 11:27:53 +01:00
Dougal Matthews
eecd83b998 Refactor gh-deploy and remove ghp-import requirement
This change modifies ghp-import to be a library and uses it instead of
calling the package with subprocess.

Fixes #598
Fixes #547
2015-06-06 10:17:26 +01:00
Waylan Limberg
975b216c79 Removed six dependency. 2015-06-03 11:26:12 -04:00
Dougal Matthews
38fc746954 Remove old release code 2015-05-25 17:40:53 +01:00
Dougal Matthews
90b2724c31 Make auto-reloading optional
Fixes #445
2015-05-10 00:32:03 +01:00
Dougal Matthews
7d4897123f Set zip_safe=False 2015-05-06 16:43:38 +01:00
Dougal Matthews
db9ca221bb Revert "Set zip_safe=False"
This reverts commit 196e30d6b1.
2015-05-06 16:43:25 +01:00
Dougal Matthews
196e30d6b1 Set zip_safe=False 2015-05-06 16:23:20 +01:00
Dougal Matthews
c3ab1cc95b Refactor the current CLI implementation to use Click
This reimplements the CLI interface to use Click, which in turn gives us
a much easier to use interface as it provides help messages for all the
commands and individual commands.

Fixes #259
2015-04-28 20:06:57 +01:00
Dougal Matthews
234bc4168d Remove mkdocs.compat and add six
Fixes #447
2015-04-23 22:27:02 +01:00
Dougal Matthews
ad7df6390a Create wheels and use twine to upload to PyPI 2015-04-21 16:32:37 +01:00
Dougal Matthews
c4cb25e584 Automatically refresh the browser on edits
Use python-livereload to automatically refresh your browser.

Closes #163
2015-04-10 09:04:20 +01:00
Dougal Matthews
2677ebb00d Remove the upper limitation for Python-Markdown on Python >=2.7 2015-04-08 12:45:28 +01:00
Dougal Matthews
f0de54b8e0 Revert "Automatically refresh the browser on edits"
This reverts commit 50327cb14d.
2015-04-08 12:23:23 +01:00
Dougal Matthews
50327cb14d Automatically refresh the browser on edits
Use python-livereload to automatically refresh your browser.

Closes #163
2015-04-06 12:07:57 +01:00
Dougal Matthews
3ed0fe8c4a Added initial descriptions for PyPi based on those on the website
Fixes #159
2014-10-23 08:03:13 +01:00
Dougal Matthews
27b3268931 Relax version requirements to accept a greater version
Fixes #104
2014-10-18 08:41:35 +01:00
Dougal Matthews
7df0c9c283 Updated classifiers for PyPI 2014-10-09 09:47:58 +01:00
Ed Brannin
9202ffdff8 Updated setup.py to use entry_points['console_scripts'] instead of scripts.
This makes a "mkdocs" command on Windows/OSX/Linux without any platform-specific code in setup.py.

I think this is the preferred way to install a Python command with setuptools.

It is, at least, the method used by:

* [flake8](8ee94d1eee/setup.py)
* [coverage.py](ca875e7390/setup.py)
* [Fabric](https://github.com/fabric/fabric/blob/master/setup.py)
* Many others

In the past, I had to change imports willy-nilly or add
"from __future__ import absolute_imports" to a bunch of files.
This is because I was renaming "mkdocs" to "mkdocs.py" instead of "main.py",
and the module-vs-script name clash was confusing imports from other files.
2014-08-17 00:01:45 -04:00
Tom Christie
305ebcf90e Add 'ghp-deploy' 2014-03-30 16:02:22 +01:00
Tom Christie
ca36975deb Tweaks for version 0.2 release 2014-01-21 17:12:23 +00:00
Tom Christie
4635afcfca Version 0.2 2014-01-21 17:00:02 +00:00
Tom Christie
1d01415069 Still awesome 2014-01-19 12:09:47 +00:00
Tom Christie
fca0ff6f93 Initial package setup 2014-01-11 21:04:32 +00:00