[Python-modules-commits] [python-mkdocs] 01/06: Import python-mkdocs_0.15.3.orig.tar.gz
Brian May
bam at moszumanska.debian.org
Thu Apr 7 02:32:27 UTC 2016
This is an automated email from the git hooks/post-receive script.
bam pushed a commit to branch master
in repository python-mkdocs.
commit 47dd578a2b91cacc50aec47aff24b7b75581e08a
Author: Brian May <bam at debian.org>
Date: Thu Apr 7 12:18:09 2016 +1000
Import python-mkdocs_0.15.3.orig.tar.gz
---
.travis.yml | 42 +-
CONTRIBUTING.md | 2 +-
MANIFEST.in | 4 +-
README.md | 10 +-
appveyor.yml | 13 +-
docs/about/contributing.md | 6 +-
docs/about/license.md | 31 +-
docs/about/release-notes.md | 106 +-
docs/css/extra.css | 4 +
docs/index.md | 203 ++-
docs/user-guide/configuration.md | 212 ++--
docs/user-guide/custom-themes.md | 436 +++++++
docs/user-guide/deploying-your-docs.md | 29 +-
docs/user-guide/styling-your-docs.md | 315 +----
docs/user-guide/writing-your-docs.md | 242 ++--
mkdocs.yml | 18 +-
mkdocs/__init__.py | 13 +-
mkdocs/{cli.py => __main__.py} | 34 +-
mkdocs/commands/__init__.py | 0
mkdocs/{ => commands}/build.py | 14 +-
mkdocs/{ => commands}/gh_deploy.py | 0
mkdocs/{ => commands}/new.py | 0
mkdocs/{ => commands}/serve.py | 6 +-
mkdocs/config/base.py | 6 +-
mkdocs/config/config_options.py | 33 +-
mkdocs/nav.py | 2 +-
mkdocs/relative_path_ext.py | 12 +-
mkdocs/search.py | 23 +-
mkdocs/tests/build_tests.py | 26 +-
mkdocs/tests/cli_tests.py | 14 +-
mkdocs/tests/config/config_options_tests.py | 26 +-
mkdocs/tests/config/config_tests.py | 39 +-
mkdocs/tests/gh_deploy_tests.py | 26 +-
mkdocs/tests/integration.py | 2 +-
mkdocs/tests/nav_tests.py | 13 +-
mkdocs/tests/new_tests.py | 2 +-
mkdocs/tests/search_tests.py | 14 +-
mkdocs/tests/utils/utils_tests.py | 42 +-
mkdocs/themes/__init__.py | 0
mkdocs/themes/amelia/base.html | 67 -
mkdocs/themes/amelia/content.html | 9 -
mkdocs/themes/amelia/css/base.css | 113 --
mkdocs/themes/amelia/css/bootstrap-custom.min.css | 1 -
mkdocs/themes/amelia/css/font-awesome-4.0.3.css | 1338 --------------------
mkdocs/themes/amelia/css/highlight.css | 125 --
mkdocs/themes/amelia/fonts/fontawesome-webfont.eot | Bin 38205 -> 0 bytes
mkdocs/themes/amelia/fonts/fontawesome-webfont.svg | 414 ------
mkdocs/themes/amelia/fonts/fontawesome-webfont.ttf | Bin 80652 -> 0 bytes
.../themes/amelia/fonts/fontawesome-webfont.woff | Bin 44432 -> 0 bytes
mkdocs/themes/amelia/img/favicon.ico | Bin 1150 -> 0 bytes
mkdocs/themes/amelia/js/base.js | 19 -
mkdocs/themes/amelia/js/bootstrap-3.0.3.min.js | 7 -
mkdocs/themes/amelia/js/highlight.pack.js | 2 -
mkdocs/themes/amelia/js/jquery-1.10.2.min.js | 6 -
mkdocs/themes/amelia/nav.html | 69 -
mkdocs/themes/amelia/toc.html | 10 -
mkdocs/themes/bootstrap/base.html | 68 -
mkdocs/themes/bootstrap/content.html | 9 -
mkdocs/themes/bootstrap/css/base.css | 113 --
.../themes/bootstrap/css/bootstrap-3.0.3.min.css | 7 -
mkdocs/themes/bootstrap/css/font-awesome-4.0.3.css | 1338 --------------------
mkdocs/themes/bootstrap/css/highlight.css | 125 --
.../themes/bootstrap/fonts/fontawesome-webfont.eot | Bin 38205 -> 0 bytes
.../themes/bootstrap/fonts/fontawesome-webfont.svg | 414 ------
.../themes/bootstrap/fonts/fontawesome-webfont.ttf | Bin 80652 -> 0 bytes
.../bootstrap/fonts/fontawesome-webfont.woff | Bin 44432 -> 0 bytes
mkdocs/themes/bootstrap/img/favicon.ico | Bin 1150 -> 0 bytes
mkdocs/themes/bootstrap/js/base.js | 20 -
mkdocs/themes/bootstrap/js/bootstrap-3.0.3.min.js | 7 -
mkdocs/themes/bootstrap/js/highlight.pack.js | 2 -
mkdocs/themes/bootstrap/js/jquery-1.10.2.min.js | 6 -
mkdocs/themes/bootstrap/nav.html | 69 -
mkdocs/themes/bootstrap/toc.html | 10 -
mkdocs/themes/cerulean/base.html | 67 -
mkdocs/themes/cerulean/content.html | 9 -
mkdocs/themes/cerulean/css/base.css | 113 --
.../themes/cerulean/css/bootstrap-custom.min.css | 1 -
mkdocs/themes/cerulean/css/font-awesome-4.0.3.css | 1338 --------------------
mkdocs/themes/cerulean/css/highlight.css | 125 --
.../themes/cerulean/fonts/fontawesome-webfont.eot | Bin 38205 -> 0 bytes
.../themes/cerulean/fonts/fontawesome-webfont.svg | 414 ------
.../themes/cerulean/fonts/fontawesome-webfont.ttf | Bin 80652 -> 0 bytes
.../themes/cerulean/fonts/fontawesome-webfont.woff | Bin 44432 -> 0 bytes
mkdocs/themes/cerulean/img/favicon.ico | Bin 1150 -> 0 bytes
mkdocs/themes/cerulean/js/base.js | 20 -
mkdocs/themes/cerulean/js/bootstrap-3.0.3.min.js | 7 -
mkdocs/themes/cerulean/js/highlight.pack.js | 2 -
mkdocs/themes/cerulean/js/jquery-1.10.2.min.js | 6 -
mkdocs/themes/cerulean/nav.html | 69 -
mkdocs/themes/cerulean/toc.html | 10 -
mkdocs/themes/cosmo/base.html | 67 -
mkdocs/themes/cosmo/content.html | 9 -
mkdocs/themes/cosmo/css/base.css | 113 --
mkdocs/themes/cosmo/css/bootstrap-custom.min.css | 1 -
mkdocs/themes/cosmo/css/font-awesome-4.0.3.css | 1338 --------------------
mkdocs/themes/cosmo/css/highlight.css | 125 --
mkdocs/themes/cosmo/fonts/fontawesome-webfont.eot | Bin 38205 -> 0 bytes
mkdocs/themes/cosmo/fonts/fontawesome-webfont.svg | 414 ------
mkdocs/themes/cosmo/fonts/fontawesome-webfont.ttf | Bin 80652 -> 0 bytes
mkdocs/themes/cosmo/fonts/fontawesome-webfont.woff | Bin 44432 -> 0 bytes
mkdocs/themes/cosmo/img/favicon.ico | Bin 1150 -> 0 bytes
mkdocs/themes/cosmo/js/base.js | 20 -
mkdocs/themes/cosmo/js/bootstrap-3.0.3.min.js | 7 -
mkdocs/themes/cosmo/js/highlight.pack.js | 2 -
mkdocs/themes/cosmo/js/jquery-1.10.2.min.js | 6 -
mkdocs/themes/cosmo/nav.html | 69 -
mkdocs/themes/cosmo/toc.html | 10 -
mkdocs/themes/cyborg/base.html | 67 -
mkdocs/themes/cyborg/content.html | 9 -
mkdocs/themes/cyborg/css/base.css | 113 --
mkdocs/themes/cyborg/css/bootstrap-custom.min.css | 1 -
mkdocs/themes/cyborg/css/font-awesome-4.0.3.css | 1338 --------------------
mkdocs/themes/cyborg/css/highlight.css | 125 --
mkdocs/themes/cyborg/fonts/fontawesome-webfont.eot | Bin 38205 -> 0 bytes
mkdocs/themes/cyborg/fonts/fontawesome-webfont.svg | 414 ------
mkdocs/themes/cyborg/fonts/fontawesome-webfont.ttf | Bin 80652 -> 0 bytes
.../themes/cyborg/fonts/fontawesome-webfont.woff | Bin 44432 -> 0 bytes
mkdocs/themes/cyborg/img/favicon.ico | Bin 1150 -> 0 bytes
mkdocs/themes/cyborg/js/base.js | 20 -
mkdocs/themes/cyborg/js/bootstrap-3.0.3.min.js | 7 -
mkdocs/themes/cyborg/js/highlight.pack.js | 2 -
mkdocs/themes/cyborg/js/jquery-1.10.2.min.js | 6 -
mkdocs/themes/cyborg/nav.html | 69 -
mkdocs/themes/cyborg/toc.html | 10 -
mkdocs/themes/flatly/base.html | 67 -
mkdocs/themes/flatly/content.html | 9 -
mkdocs/themes/flatly/css/base.css | 113 --
mkdocs/themes/flatly/css/bootstrap-custom.min.css | 1 -
mkdocs/themes/flatly/css/font-awesome-4.0.3.css | 1338 --------------------
mkdocs/themes/flatly/css/highlight.css | 125 --
mkdocs/themes/flatly/fonts/fontawesome-webfont.eot | Bin 38205 -> 0 bytes
mkdocs/themes/flatly/fonts/fontawesome-webfont.svg | 414 ------
mkdocs/themes/flatly/fonts/fontawesome-webfont.ttf | Bin 80652 -> 0 bytes
.../themes/flatly/fonts/fontawesome-webfont.woff | Bin 44432 -> 0 bytes
mkdocs/themes/flatly/img/favicon.ico | Bin 1150 -> 0 bytes
mkdocs/themes/flatly/js/base.js | 20 -
mkdocs/themes/flatly/js/bootstrap-3.0.3.min.js | 7 -
mkdocs/themes/flatly/js/highlight.pack.js | 2 -
mkdocs/themes/flatly/js/jquery-1.10.2.min.js | 6 -
mkdocs/themes/flatly/nav.html | 69 -
mkdocs/themes/flatly/toc.html | 10 -
mkdocs/themes/journal/base.html | 67 -
mkdocs/themes/journal/content.html | 9 -
mkdocs/themes/journal/css/base.css | 113 --
mkdocs/themes/journal/css/bootstrap-custom.min.css | 1 -
mkdocs/themes/journal/css/font-awesome-4.0.3.css | 1338 --------------------
mkdocs/themes/journal/css/highlight.css | 125 --
.../themes/journal/fonts/fontawesome-webfont.eot | Bin 38205 -> 0 bytes
.../themes/journal/fonts/fontawesome-webfont.svg | 414 ------
.../themes/journal/fonts/fontawesome-webfont.ttf | Bin 80652 -> 0 bytes
.../themes/journal/fonts/fontawesome-webfont.woff | Bin 44432 -> 0 bytes
mkdocs/themes/journal/img/favicon.ico | Bin 1150 -> 0 bytes
mkdocs/themes/journal/js/base.js | 20 -
mkdocs/themes/journal/js/bootstrap-3.0.3.min.js | 7 -
mkdocs/themes/journal/js/highlight.pack.js | 2 -
mkdocs/themes/journal/js/jquery-1.10.2.min.js | 6 -
mkdocs/themes/journal/nav.html | 69 -
mkdocs/themes/journal/toc.html | 10 -
mkdocs/themes/mkdocs/__init__.py | 0
mkdocs/themes/mkdocs/base.html | 2 +-
mkdocs/themes/mkdocs/css/base.css | 2 +
mkdocs/themes/mkdocs/css/font-awesome-4.0.3.css | 1338 --------------------
mkdocs/themes/mkdocs/css/font-awesome-4.5.0.css | 4 +
mkdocs/themes/mkdocs/fonts/FontAwesome.otf | Bin 0 -> 109688 bytes
mkdocs/themes/mkdocs/fonts/fontawesome-webfont.eot | Bin 38205 -> 70807 bytes
mkdocs/themes/mkdocs/fonts/fontawesome-webfont.svg | 317 ++++-
mkdocs/themes/mkdocs/fonts/fontawesome-webfont.ttf | Bin 80652 -> 142072 bytes
.../themes/mkdocs/fonts/fontawesome-webfont.woff | Bin 44432 -> 83588 bytes
.../themes/mkdocs/fonts/fontawesome-webfont.woff2 | Bin 0 -> 66624 bytes
mkdocs/themes/readable/base.html | 67 -
mkdocs/themes/readable/content.html | 9 -
mkdocs/themes/readable/css/base.css | 113 --
.../themes/readable/css/bootstrap-custom.min.css | 1 -
mkdocs/themes/readable/css/font-awesome-4.0.3.css | 1338 --------------------
mkdocs/themes/readable/css/highlight.css | 125 --
.../themes/readable/fonts/fontawesome-webfont.eot | Bin 38205 -> 0 bytes
.../themes/readable/fonts/fontawesome-webfont.svg | 414 ------
.../themes/readable/fonts/fontawesome-webfont.ttf | Bin 80652 -> 0 bytes
.../themes/readable/fonts/fontawesome-webfont.woff | Bin 44432 -> 0 bytes
mkdocs/themes/readable/img/favicon.ico | Bin 1150 -> 0 bytes
mkdocs/themes/readable/js/base.js | 20 -
mkdocs/themes/readable/js/bootstrap-3.0.3.min.js | 7 -
mkdocs/themes/readable/js/highlight.pack.js | 2 -
mkdocs/themes/readable/js/jquery-1.10.2.min.js | 6 -
mkdocs/themes/readable/nav.html | 69 -
mkdocs/themes/readable/toc.html | 10 -
mkdocs/themes/readthedocs/__init__.py | 0
mkdocs/themes/readthedocs/base.html | 5 +
mkdocs/themes/readthedocs/css/theme_extra.css | 14 +-
mkdocs/themes/readthedocs/footer.html | 2 +-
mkdocs/themes/readthedocs/versions.html | 4 +-
mkdocs/themes/simplex/base.html | 67 -
mkdocs/themes/simplex/content.html | 9 -
mkdocs/themes/simplex/css/base.css | 113 --
mkdocs/themes/simplex/css/bootstrap-custom.min.css | 1 -
mkdocs/themes/simplex/css/font-awesome-4.0.3.css | 1338 --------------------
mkdocs/themes/simplex/css/highlight.css | 125 --
.../themes/simplex/fonts/fontawesome-webfont.eot | Bin 38205 -> 0 bytes
.../themes/simplex/fonts/fontawesome-webfont.svg | 414 ------
.../themes/simplex/fonts/fontawesome-webfont.ttf | Bin 80652 -> 0 bytes
.../themes/simplex/fonts/fontawesome-webfont.woff | Bin 44432 -> 0 bytes
mkdocs/themes/simplex/img/favicon.ico | Bin 1150 -> 0 bytes
mkdocs/themes/simplex/js/base.js | 20 -
mkdocs/themes/simplex/js/bootstrap-3.0.3.min.js | 7 -
mkdocs/themes/simplex/js/highlight.pack.js | 2 -
mkdocs/themes/simplex/js/jquery-1.10.2.min.js | 6 -
mkdocs/themes/simplex/nav.html | 69 -
mkdocs/themes/simplex/toc.html | 10 -
mkdocs/themes/slate/base.html | 67 -
mkdocs/themes/slate/content.html | 9 -
mkdocs/themes/slate/css/base.css | 113 --
mkdocs/themes/slate/css/bootstrap-custom.min.css | 1 -
mkdocs/themes/slate/css/font-awesome-4.0.3.css | 1338 --------------------
mkdocs/themes/slate/css/highlight.css | 125 --
mkdocs/themes/slate/fonts/fontawesome-webfont.eot | Bin 38205 -> 0 bytes
mkdocs/themes/slate/fonts/fontawesome-webfont.svg | 414 ------
mkdocs/themes/slate/fonts/fontawesome-webfont.ttf | Bin 80652 -> 0 bytes
mkdocs/themes/slate/fonts/fontawesome-webfont.woff | Bin 44432 -> 0 bytes
mkdocs/themes/slate/img/favicon.ico | Bin 1150 -> 0 bytes
mkdocs/themes/slate/js/base.js | 20 -
mkdocs/themes/slate/js/bootstrap-3.0.3.min.js | 7 -
mkdocs/themes/slate/js/highlight.pack.js | 2 -
mkdocs/themes/slate/js/jquery-1.10.2.min.js | 6 -
mkdocs/themes/slate/nav.html | 69 -
mkdocs/themes/slate/toc.html | 10 -
mkdocs/themes/spacelab/base.html | 67 -
mkdocs/themes/spacelab/content.html | 9 -
mkdocs/themes/spacelab/css/base.css | 113 --
.../themes/spacelab/css/bootstrap-custom.min.css | 1 -
mkdocs/themes/spacelab/css/font-awesome-4.0.3.css | 1338 --------------------
mkdocs/themes/spacelab/css/highlight.css | 125 --
.../themes/spacelab/fonts/fontawesome-webfont.eot | Bin 38205 -> 0 bytes
.../themes/spacelab/fonts/fontawesome-webfont.svg | 414 ------
.../themes/spacelab/fonts/fontawesome-webfont.ttf | Bin 80652 -> 0 bytes
.../themes/spacelab/fonts/fontawesome-webfont.woff | Bin 44432 -> 0 bytes
mkdocs/themes/spacelab/img/favicon.ico | Bin 1150 -> 0 bytes
mkdocs/themes/spacelab/js/base.js | 20 -
mkdocs/themes/spacelab/js/bootstrap-3.0.3.min.js | 7 -
mkdocs/themes/spacelab/js/highlight.pack.js | 2 -
mkdocs/themes/spacelab/js/jquery-1.10.2.min.js | 6 -
mkdocs/themes/spacelab/nav.html | 69 -
mkdocs/themes/spacelab/toc.html | 10 -
mkdocs/themes/united/base.html | 67 -
mkdocs/themes/united/content.html | 9 -
mkdocs/themes/united/css/base.css | 113 --
mkdocs/themes/united/css/bootstrap-custom.min.css | 1 -
mkdocs/themes/united/css/font-awesome-4.0.3.css | 1338 --------------------
mkdocs/themes/united/css/highlight.css | 125 --
mkdocs/themes/united/fonts/fontawesome-webfont.eot | Bin 38205 -> 0 bytes
mkdocs/themes/united/fonts/fontawesome-webfont.svg | 414 ------
mkdocs/themes/united/fonts/fontawesome-webfont.ttf | Bin 80652 -> 0 bytes
.../themes/united/fonts/fontawesome-webfont.woff | Bin 44432 -> 0 bytes
mkdocs/themes/united/img/favicon.ico | Bin 1150 -> 0 bytes
mkdocs/themes/united/js/base.js | 20 -
mkdocs/themes/united/js/bootstrap-3.0.3.min.js | 7 -
mkdocs/themes/united/js/highlight.pack.js | 2 -
mkdocs/themes/united/js/jquery-1.10.2.min.js | 6 -
mkdocs/themes/united/nav.html | 69 -
mkdocs/themes/united/toc.html | 10 -
mkdocs/themes/yeti/base.html | 67 -
mkdocs/themes/yeti/content.html | 9 -
mkdocs/themes/yeti/css/base.css | 113 --
mkdocs/themes/yeti/css/bootstrap-custom.min.css | 1 -
mkdocs/themes/yeti/css/font-awesome-4.0.3.css | 1338 --------------------
mkdocs/themes/yeti/css/highlight.css | 125 --
mkdocs/themes/yeti/fonts/fontawesome-webfont.eot | Bin 38205 -> 0 bytes
mkdocs/themes/yeti/fonts/fontawesome-webfont.svg | 414 ------
mkdocs/themes/yeti/fonts/fontawesome-webfont.ttf | Bin 80652 -> 0 bytes
mkdocs/themes/yeti/fonts/fontawesome-webfont.woff | Bin 44432 -> 0 bytes
mkdocs/themes/yeti/img/favicon.ico | Bin 1150 -> 0 bytes
mkdocs/themes/yeti/js/base.js | 20 -
mkdocs/themes/yeti/js/bootstrap-3.0.3.min.js | 7 -
mkdocs/themes/yeti/js/highlight.pack.js | 2 -
mkdocs/themes/yeti/js/jquery-1.10.2.min.js | 6 -
mkdocs/themes/yeti/nav.html | 69 -
mkdocs/themes/yeti/toc.html | 10 -
mkdocs/toc.py | 7 +
mkdocs/utils/__init__.py | 71 +-
requirements/project-min.txt | 8 +
requirements/project.txt | 4 +-
requirements/test.txt | 2 +-
setup.py | 31 +-
tox.ini | 17 +-
283 files changed, 1781 insertions(+), 30426 deletions(-)
diff --git a/.travis.yml b/.travis.yml
index ed0e426..d5f9640 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -1,19 +1,49 @@
+sudo: false
language: python
-python: '2.7'
+python: '3.5'
env:
-- TOXENV=py26-unittests
-- TOXENV=py27-unittests
-- TOXENV=py33-unittests
-- TOXENV=py34-unittests
- TOXENV=py26-integration
+- TOXENV=py26-min-req
+- TOXENV=py26-unittests
- TOXENV=py27-integration
+- TOXENV=py27-min-req
+- TOXENV=py27-unittests
- TOXENV=py33-integration
+- TOXENV=py33-min-req
+- TOXENV=py33-unittests
- TOXENV=py34-integration
+- TOXENV=py34-min-req
+- TOXENV=py34-unittests
+- TOXENV=py35-integration
+- TOXENV=py35-min-req
+- TOXENV=py35-unittests
+- TOXENV=pypy-integration
+- TOXENV=pypy-min-req
+- TOXENV=pypy-unittests
+- TOXENV=pypy3-integration
+- TOXENV=pypy3-min-req
+- TOXENV=pypy3-unittests
- TOXENV=flake8
+- TOXENV=markdown-lint
install:
- pip install tox
-script: tox
+- gem install mdl
+script:
+- git clean -f -d -x
+- tox
matrix:
fast_finish: true
+ allow_failures:
+ - env: TOXENV=markdown-lint
before_install: pip install codecov
after_success: codecov
+deploy:
+ provider: pypi
+ user: mkdocsdeploy
+ distributions: "sdist bdist_wheel"
+ password:
+ secure: b4f6y1xw5B/RXXnOu6JIaNcgOBZ0/CkNaMeEXsoQSewYZNwobLPYALY9WaaOblarwrVa5NRD3e4x6SoL1/1NzQxfhCNMn7L82sssmtevnK+mSuUp4IZQa8WKyz+xLfnk28TlHgQbctAU9NaeQ6GuEflTRD7Bp8+xJ1C7h+yBUnw=
+ on:
+ tags: true
+ repo: mkdocs/mkdocs
+ condition: "$TOXENV = py27-integration"
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3710c7b..77de742 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -3,4 +3,4 @@
See the contributing guide in the documentation for an
introduction to contributing to MkDocs.
-http://www.mkdocs.org/about/contributing/
+<http://www.mkdocs.org/about/contributing/>
diff --git a/MANIFEST.in b/MANIFEST.in
index 7a4ec20..a0a5a2b 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,3 +1,5 @@
-recursive-include mkdocs/themes *.ico *.js *.css *.png *.html *.eot *.svg *.ttf *.woff
+include README.md
+include LICENSE.md
+recursive-include mkdocs *.ico *.js *.css *.png *.html *.eot *.svg *.ttf *.woff *.xml *.mustache
recursive-exclude * __pycache__
recursive-exclude * *.py[co]
diff --git a/README.md b/README.md
index 2d24ad6..3c34978 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,8 @@
# MkDocs
-**Project documentation with Markdown.**
+Project documentation with Markdown.
+
+---
[![PyPI Downloads][pypi-dl-image]][pypi-dl-link]
[![PyPI Version][pypi-v-image]][pypi-v-link]
@@ -9,15 +11,15 @@
[![Coverage Status][codecov-image]][codecov-link]
[![Landscale Code Health][landscape-image]][landscape-link]
-**See the MkDocs documentation: [www.mkdocs.org][mkdocs]**
+## [See the MkDocs documentation: www.mkdocs.org][mkdocs]
-Release notes: http://www.mkdocs.org/about/release-notes/
+Release notes: <http://www.mkdocs.org/about/release-notes/>
Project roadmap: [https://github.com/mkdocs/mkdocs/wiki][roadmap]
IRC channel: `#mkdocs` on freenode.
-Discussions and support: https://groups.google.com/forum/#!forum/mkdocs
+Discussions and support: <https://groups.google.com/forum/#!forum/mkdocs>
[appveyor-image]: https://img.shields.io/appveyor/ci/d0ugal/mkdocs/master.png
[appveyor-link]: https://ci.appveyor.com/project/d0ugal/mkdocs
diff --git a/appveyor.yml b/appveyor.yml
index 4ef8228..cad24ee 100644
--- a/appveyor.yml
+++ b/appveyor.yml
@@ -1,12 +1,18 @@
build: false
environment:
matrix:
- - TOXENV: py27-unittests
- - TOXENV: py33-unittests
- - TOXENV: py34-unittests
- TOXENV: py27-integration
+ - TOXENV: py27-min-req
+ - TOXENV: py27-unittests
- TOXENV: py33-integration
+ - TOXENV: py33-min-req
+ - TOXENV: py33-unittests
- TOXENV: py34-integration
+ - TOXENV: py34-min-req
+ - TOXENV: py34-unittests
+ - TOXENV: py35-integration
+ - TOXENV: py35-min-req
+ - TOXENV: py35-unittests
- TOXENV: flake8
init:
- "ECHO %TOXENV%"
@@ -18,6 +24,7 @@ install:
- "c:\\python27\\python c:\\get-pip.py"
- "c:\\python27\\Scripts\\pip install tox"
test_script:
+ - "git clean -f -d -x"
- "c:\\python27\\Scripts\\tox --version"
- "c:\\python27\\Scripts\\pip --version"
- "c:\\python27\\Scripts\\tox"
diff --git a/docs/about/contributing.md b/docs/about/contributing.md
index 8e360b9..953b05c 100644
--- a/docs/about/contributing.md
+++ b/docs/about/contributing.md
@@ -10,14 +10,13 @@ ways, a few examples are:
- Documentation improvements
- Bug reports and patch reviews
-## Reporting an Issue?
+## Reporting an Issue
Please include as much detail as you can. Let us know your platform and MkDocs
version. If the problem is visual (for example a theme or design issue) please
-add a screenshot and if you get an error please include the the full error and
+add a screenshot and if you get an error please include the full error and
traceback.
-
## Testing the Development Version
If you want to just install and try out the latest development version of
@@ -43,7 +42,6 @@ pip install --editable .
This will install MkDocs in development mode which binds the `mkdocs` command
to the git repository.
-
## Running the tests
To run the tests, it is recommended that you use [Tox]. This just needs
diff --git a/docs/about/license.md b/docs/about/license.md
index c99eb25..a41499f 100644
--- a/docs/about/license.md
+++ b/docs/about/license.md
@@ -4,9 +4,10 @@ The legal stuff.
---
-#### Included projects
+## Included projects
-Themes used under license from the Bootstrap, ReadTheDocs, GhostWriter and Bootswatch projects.
+Themes used under license from the Bootstrap, ReadTheDocs, GhostWriter and
+Bootswatch projects.
* Bootstrap theme - [View license](//github.com/twbs/bootstrap/blob/master/LICENSE).
* ReadTheDocs theme - [View license](//github.com/snide/sphinx_rtd_theme/blob/master/LICENSE).
@@ -15,12 +16,26 @@ Themes used under license from the Bootstrap, ReadTheDocs, GhostWriter and Boots
Many thanks to the authors and contributors of those wonderful projects.
-#### MkDocs License (BSD)
+## MkDocs License (BSD)
Copyright © 2014, Tom Christie. All rights reserved.
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROF [...]
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list
+of conditions and the following disclaimer. Redistributions in binary form must
+reproduce the above copyright notice, this list of conditions and the following
+disclaimer in the documentation and/or other materials provided with the
+distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/docs/about/release-notes.md b/docs/about/release-notes.md
index 099571a..84f47c9 100644
--- a/docs/about/release-notes.md
+++ b/docs/about/release-notes.md
@@ -11,7 +11,74 @@ To upgrade MkDocs to the latest version, use pip:
You can determine your currently installed version using `mkdocs --version`:
$ mkdocs --version
- mkdocs, version 0.14.0
+ mkdocs, version 0.15.2
+
+
+## Version 0.15.3 (2016-02-18)
+
+* Improve the error message the given theme can't be found.
+* Fix an issue with relative symlinks (#639)
+
+## Version 0.15.2 (2016-02-08)
+
+* Fix an incorrect warning that states external themes [will be removed from
+ MkDocs](#add-support-for-installable-themes).
+
+## Version 0.15.1 (2016-01-30)
+
+* Lower the minimum supported Click version to 3.3 for package maintainers.
+ (#763)
+
+## Version 0.15.0 (2016-01-21)
+
+### Major Additions to Version 0.15.0
+
+#### Add support for installable themes
+
+MkDocs now supports themes that are distributed via Python packages. With this
+addition, the Bootstrap and Bootswatch themes have been moved to external git
+repositories and python packages. See their individual documentation for more
+details about these specific themes.
+
+* [MkDocs Bootstrap]
+* [MkDocs Bootswatch]
+
+[MkDocs Bootstrap]: http://mkdocs.github.io/mkdocs-bootstrap/
+[MkDocs Bootswatch]: http://mkdocs.github.io/mkdocs-bootswatch/
+
+They will be included with MkDocs by default until the 1.0 release. After that
+they will be installable with pip: `pip install mkdocs-bootstrap` and `pip
+install mkdocs-bootswatch`
+
+See the documentation for [Styling your docs] for more information about using
+and customising themes and [Custom themes] for creating and distributing new
+themes
+
+[Styling your docs]: /user-guide/styling-your-docs.md
+[Custom themes]: /user-guide/custom-themes.md
+
+### Other Changes and Additions to Version 0.15.0
+
+* Fix issues when using absolute links to Markdown files. (#628)
+* Deprecate support of Python 2.6, pending removal in 1.0.0. (#165)
+* Add official support for Python version 3.5.
+* Add support for [site_description] and [site_author] to the [ReadTheDocs]
+ theme. (#631)
+* Update FontAwesome to 4.5.0. (#789)
+* Increase IE support with X-UA-Compatible. (#785)
+* Added support for Python's `-m` flag. (#706)
+* Bugfix: Ensure consistent ordering of auto-populated pages. (#638)
+* Bugfix: Scroll the tables of contents on the MkDocs theme if it is too long
+ for the page. (#204)
+* Bugfix: Add all ancestors to the page attribute `ancestors` rather than just
+ the initial one. (#693)
+* Bugfix: Include HTML in the build output again. (#691)
+* Bugfix: Provide filename to Read the Docs. (#721 and RTD#1480)
+* Bugfix: Silence Click's unicode_literals warning. (#708)
+
+[site_description]: /user-guide/configuration.md#site_description
+[site_author]: /user-guide/configuration.md#site_author
+[ReadTheDocs]: /user-guide/styling-your-docs.md#readthedocs
## Version 0.14.0 (2015-06-09)
@@ -48,10 +115,9 @@ You can determine your currently installed version using `mkdocs --version`:
* Bugfix: Fix a problem with minimal configurations which only contain a list
of paths in the pages config. (#562)
-
## Version 0.13.0 (2015-05-26)
-### Deprecations
+### Deprecations to Version 0.13.0
#### Deprecate the JSON command
@@ -70,7 +136,7 @@ This new file is created on every MkDocs build (with `mkdocs build`) and
no configuration is needed to enable it.
[future release]: https://github.com/mkdocs/mkdocs/pull/481
-[site_dir]: /user-guide/configuration/#site_dir
+[site_dir]: /user-guide/configuration.md#site_dir
#### Change the pages configuration
@@ -78,8 +144,8 @@ Provide a [new way] to define pages, and specifically [nested pages], in the
mkdocs.yml file and deprecate the existing approach, support will be removed
with MkDocs 1.0.
-[new way]: /user-guide/writing-your-docs/#configure-pages-and-navigation
-[nested pages]: /user-guide/writing-your-docs/#multilevel-documentation
+[new way]: /user-guide/writing-your-docs.md#configure-pages-and-navigation
+[nested pages]: /user-guide/writing-your-docs.md#multilevel-documentation
#### Warn users about the removal of builtin themes
@@ -87,8 +153,7 @@ All themes other than mkdocs and readthedocs will be moved into external
packages in a future release of MkDocs. This will enable them to be more easily
supported and updates outside MkDocs releases.
-
-### Major Additions
+### Major Additions to Version 0.13.0
#### Search
@@ -98,7 +163,7 @@ JavaScript library [lunr.js]. It has been added to both the `mkdocs` and
for adding it to your own themes.
[lunr.js]: http://lunrjs.com/
-[supporting search]: /user-guide/styling-your-docs/#search-and-themes
+[supporting search]: /user-guide/styling-your-docs.md#search-and-themes
#### New Command Line Interface
@@ -126,12 +191,12 @@ can also use Jinja2 syntax and take advantage of the [global variables].
By default MkDocs will use this approach to create a sitemap for the
documentation.
-[extra_javascript]: /user-guide/configuration/#extra_javascript
-[extra_css]: /user-guide/configuration/#extra_css
-[extra_templates]: /user-guide/configuration/#extra_templates
-[global variables]: /user-guide/styling-your-docs/#global-context
+[extra_javascript]: /user-guide/configuration.md#extra_javascript
+[extra_css]: /user-guide/configuration.md#extra_css
+[extra_templates]: /user-guide/configuration.md#extra_templates
+[global variables]: /user-guide/styling-your-docs.md#global-context
-### Other Changes and Additions
+### Other Changes and Additions to Version 0.13.0
* Add support for [Markdown extension configuration options]. (#435)
* MkDocs now ships Python [wheels]. (#486)
@@ -142,26 +207,24 @@ documentation.
* Add `--no-livereload` to `mkdocs serve` for a simpler development server. (#511)
* Add copyright display support to all themes (#549)
* Add support for custom commit messages in a `mkdocs gh-deploy` (#516)
-* Bugfix: Fix linking to media within the same directory as a markdown file called index.md (#535)
+* Bugfix: Fix linking to media within the same directory as a markdown file
+ called index.md (#535)
* Bugfix: Fix errors with unicode filenames (#542).
-[extra config]: /user-guide/configuration/#extra
-[Markdown extension configuration options]: /user-guide/configuration/#markdown_extensions
+[extra config]: /user-guide/configuration.md#extra
+[Markdown extension configuration options]: /user-guide/configuration.md#markdown_extensions
[wheels]: http://pythonwheels.com/
-
## Version 0.12.2 (2015-04-22)
* Bugfix: Fix a regression where there would be an error if some child titles
were missing but others were provided in the pages config. (#464)
-
## Version 0.12.1 (2015-04-14)
* Bugfix: Fixed a CSS bug in the table of contents on some browsers where the
bottom item was not clickable.
-
## Version 0.12.0 (2015-04-14)
* Display the current MkDocs version in the CLI output. (#258)
@@ -217,13 +280,11 @@ documentation.
* Bugfix: Don't block newer verions of Python-markdown on Python >= 2.7. (#376)
* Bugfix: Fix encoding issues when opening files across platforms. (#428)
-
## Version 0.11.1 (2014-11-20)
* Bugfix: Fix a CSS wrapping issue with code highlighting in the ReadTheDocs
theme. (#233)
-
## Version 0.11.0 (2014-11-18)
* Render 404.html files if they exist for the current theme. (#194)
@@ -239,7 +300,6 @@ documentation.
filesystems without inotify. (#184)
* Bugfix: Improve error output for common configuration related errors. (#176)
-
## Version 0.10.0 (2014-10-29)
* Added support for Python 3.3 and 3.4. (#103)
diff --git a/docs/css/extra.css b/docs/css/extra.css
index c1b6d58..5602f86 100644
--- a/docs/css/extra.css
+++ b/docs/css/extra.css
@@ -15,3 +15,7 @@ div.col-md-9 p.admonition-title:first-of-type {
div.col-md-9 h1:first-of-type .headerlink {
display: none;
}
+
+code.no-highlight {
+ color: black;
+}
diff --git a/docs/index.md b/docs/index.md
index efa22f6..8951157 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -6,42 +6,46 @@ Project documentation with Markdown.
## Overview
-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.
+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.
----
-
-**MkDocs is currently still in development.**
+### Host anywhere
-We're progressing quickly, but the documentation still needs filling in, and there are a few rough edges. The 1.0 release is planned to arrive in the next few months.
-
----
+Builds completely static HTML sites that you can host on GitHub pages, Amazon
+S3, or anywhere else you choose.
-#### Host anywhere.
+### Great themes available
-Builds completely static HTML sites that you can host on GitHub pages, Amazon S3, or anywhere else you choose.
+There's a stack of good looking themes included by default. Choose from
+bootstrap, readthedocs, or any of the 12 bootswatch themes.
-#### Great themes available.
+### Preview your site as you work
-There's a stack of good looking themes included by default. Choose from bootstrap, readthedocs, or any of the 12 bootswatch themes.
+The built-in devserver allows you to preview your documentation as you're
+writing it. It will even auto-reload whenever you save any changes, so all you
+need to do to see your latest edits is refresh your browser.
-#### Preview your site as you work.
+### Easy to customize
-The built-in devserver allows you to preview your documentation as you're writing it. It will even auto-reload whenever you save any changes, so all you need to do to see your latest edits is refresh your browser.
-
-#### Easy to customize.
-
-Get your project documentation looking just the way you want it by customizing the theme.
+Get your project documentation looking just the way you want it by customizing
+the theme.
---
## Installation
-In order to install MkDocs you'll need [Python] installed on your system, as well as the Python package manager, [pip]. You can check if you have these already installed like so:
+In order to install MkDocs you'll need [Python] installed on your system, as
+well as the Python package manager, [pip]. You can check if you have these
+already installed like so:
- $ python --version
- Python 2.7.2
- $ pip --version
- pip 1.5.2
+```bash
+$ python --version
+Python 2.7.2
+$ pip --version
+pip 1.5.2
+```
MkDocs supports Python 2.6, 2.7, 3.3 and 3.4.
@@ -49,43 +53,61 @@ On Windows we recommend that you install Python and pip with [Chocolatey].
Install the `mkdocs` package using pip:
- $ pip install mkdocs
+```bash
+pip install mkdocs
+```
-You should now have the `mkdocs` command installed on your system. Run `mkdocs help` to check that everything worked okay.
+You should now have the `mkdocs` command installed on your system. Run `mkdocs
+--version` to check that everything worked okay.
- $ mkdocs help
- mkdocs [help|new|build|serve|gh-deploy] {options}
+```bash
+$ mkdocs --version
+mkdocs, version 0.15.2
+```
---
-
## Getting started
Getting started is super easy.
- $ mkdocs new my-project
- $ cd my-project
+```bash
+mkdocs new my-project
+cd my-project
+```
Let's take a moment to review the initial project that's been created for us.
-There's a single configuration file named `mkdocs.yml`, and a folder named `docs` that will contain our documentation source files. Right now the `docs` folder just contains a single documentation page, named `index.md`.
+There's a single configuration file named `mkdocs.yml`, and a folder named
+`docs` that will contain our documentation source files. Right now the `docs`
+folder just contains a single documentation page, named `index.md`.
-MkDocs comes with a built-in webserver that lets you preview your documentation as you work on it. We start the webserver by making sure we're in the same directory as the `mkdocs.yml` config file, and then running the `mkdocs serve` command:
+MkDocs comes with a built-in webserver that lets you preview your documentation
+as you work on it. We start the webserver by making sure we're in the same
+directory as the `mkdocs.yml` config file, and then running the `mkdocs serve`
+command:
- $ mkdocs serve
- Running at: http://127.0.0.1:8000/
+```bash
+$ mkdocs serve
+Running at: http://127.0.0.1:8000/
+```
-Open up [http://127.0.0.1:8000/](http://127.0.0.1:8000/) in your browser, and you'll see the index page being displayed:
+Open up [http://127.0.0.1:8000/](http://127.0.0.1:8000/) in your browser, and
+you'll see the index page being displayed:
-The webserver also supports auto-reloading, and will rebuild your documentation whenever anything in the configuration file, documentation directory or theme directory changes.
+The webserver also supports auto-reloading, and will rebuild your documentation
+whenever anything in the configuration file, documentation directory or theme
+directory changes.
-Go ahead and edit the `docs/index.md` file now and save the file. Then simply hit reload in the browser and you'll see your updated documentation.
+Go ahead and edit the `docs/index.md` file now and save the file. Then simply
+hit reload in the browser and you'll see your updated documentation.
-Now's also a good time to edit the configuration file, `mkdocs.yml`. Change the `site_name` setting to something else and save the file.
+Now's also a good time to edit the configuration file, `mkdocs.yml`. Change the
+`site_name` setting to something else and save the file.
@@ -95,31 +117,43 @@ Once you hit reload in the browser you'll see your new site name take effect.
## Adding pages
-Go ahead and edit the `doc/index.md` document, and change the initial heading to `MkLorum`, then reload the site in your browser, and you should see the change take effect immediately.
+Go ahead and edit the `docs/index.md` document, and change the initial heading to
+`MkLorum`, then reload the site in your browser, and you should see the change
+take effect immediately.
Let's also add a second page to our documentation:
- $ curl 'jaspervdj.be/lorem-markdownum/markdown.txt' > docs/about.md
+```bash
+curl 'jaspervdj.be/lorem-markdownum/markdown.txt' > docs/about.md
+```
-We'd like our documentation site to include some navigation headers, so we'll edit the configuration file and add some information about the order and title to use for out headers:
+We'd like our documentation site to include some navigation headers, so we'll
+edit the configuration file and add some information about the order and title
+to use for out headers:
- site_name: MkLorum
- pages:
- - Home: index.md
- - About: about.md
+```no-highlight
+site_name: MkLorum
+pages:
+- Home: index.md
+- About: about.md
+```
-Refresh the browser and you'll now see a navigation bar with `Home` and `About` headers.
+Refresh the browser and you'll now see a navigation bar with `Home` and `About`
+headers.
## Theming our documentation
-While we're here can also change the configuration file to alter how the documentation is displayed. Let's go ahead and change the theme. Edit the `mkdocs.yml` file to the following:
-
- site_name: MkLorum
- pages:
- - Home: index.md
- - About: about.md
- theme: readthedocs
+While we're here can also change the configuration file to alter how the
+documentation is displayed. Let's go ahead and change the theme. Edit the
+`mkdocs.yml` file to the following:
+```no-highlight
+site_name: MkLorum
+pages:
+- Home: index.md
+- About: about.md
+theme: readthedocs
+```
Refresh the browser again, and you'll now see the ReadTheDocs theme being used.
@@ -127,40 +161,73 @@ Refresh the browser again, and you'll now see the ReadTheDocs theme being used.
## Building the site
-That's looking good. We're ready to deploy the first pass of our `MkLorum` documentation now. Let's build the documentation.
+That's looking good. We're ready to deploy the first pass of our `MkLorum`
+documentation now. Let's build the documentation.
+
+```bash
+mkdocs build
+```
+
+This will create a new directory, named `site`. Let's take a look inside the
+directory:
- $ mkdocs build
+```bash
+ls site
+about css fonts img index.html js
+```
-This will create a new directory, named `site`. Let's take a look inside the directory:
+Notice that our source documentation has been output as two HTML files named
+`index.html` and `about/index.html`. We also have various other media that's
+been copied into the `site` directory as part of the documentation theme.
- $ ls site
- about css fonts img index.html js
+If you're using source code control such as `git` you probably don't want to
+check your documentation builds into the repository. Add a line containing
+`site/` to your `.gitignore` file.
-Notice that our source documentation has been output as two HTML files named `index.html` and `about/index.html`. We also have various other media that's been copied into the `site` directory as part of the documentation theme.
+```bash
+echo "site/" >> .gitignore
+```
-If you're using source code control such as `git` you probably don't want to check your documentation builds into the repository. Add a line containing `site/` to your `.gitignore` file.
+If you're using another source code control you'll want to check it's
+documentation on how to ignore specific directories.
- $ echo "site/" >> .gitignore
+After some time, files may be removed from the documentation but they will still
+reside in the `site` directory. To remove those stale files, just run mkdocs
+with the `--clean` switch.
-If you're using another source code control you'll want to check it's documentation on how to ignore specific directories.
+```bash
+mkdocs build --clean
+```
-After some time, files may be removed from the documentation but they will still reside in the `site` directory. To remove those stale files, just run mkdocs with the `--clean` switch.
+## Other Commands and Options
- $ mkdocs build --clean
+There are various other commands and options available. For a complete list of
+commands, use the `--help` flag:
+```bash
... 34530 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-mkdocs.git
More information about the Python-modules-commits
mailing list