From b62ddeda02fadcd09def9354eb2ef46a7562a106 Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Wed, 6 Dec 2017 23:18:29 -0500 Subject: Switch docs to MKDocs (#602) Fixes #601. Merged in 6f87b32 from the md3 branch and did a lot of cleanup. Changes include: * Removed old docs build tool, templates, etc. * Added MkDocs config file, etc. * filename.txt => filename.md * pythonhost.org/Markdown => Python-Markdown.github.io * Markdown lint and other cleanup. * Automate pages deployment in makefile with `mkdocs gh-deploy` Assumes a git remote is set up named "pages". Do git remote add pages https://github.com/Python-Markdown/Python-Markdown.github.io.git ... before running `make deploy` the first time. --- .gitignore | 1 + CODE_OF_CONDUCT.md | 1 - INSTALL.md | 4 +- LICENSE.md | 25 +- README.md | 55 ++- checkspelling.sh | 8 +- docs/_template.html | 81 ---- docs/authors.md | 58 +++ docs/authors.txt | 60 --- docs/basic.css | 445 -------------------- docs/change_log.txt | 230 ----------- docs/change_log/index.md | 226 +++++++++++ docs/change_log/release-2.0.md | 69 ++++ docs/change_log/release-2.1.md | 119 ++++++ docs/change_log/release-2.2.md | 64 +++ docs/change_log/release-2.3.md | 85 ++++ docs/change_log/release-2.4.md | 73 ++++ docs/change_log/release-2.5.md | 189 +++++++++ docs/change_log/release-2.6.md | 306 ++++++++++++++ docs/cli.md | 171 ++++++++ docs/cli.txt | 153 ------- docs/default.css | 261 ------------ docs/extensions/abbreviations.md | 45 +++ docs/extensions/abbreviations.txt | 45 --- docs/extensions/admonition.md | 84 ++++ docs/extensions/admonition.txt | 75 ---- docs/extensions/api.md | 720 +++++++++++++++++++++++++++++++++ docs/extensions/api.txt | 682 ------------------------------- docs/extensions/attr_list.md | 98 +++++ docs/extensions/attr_list.txt | 88 ---- docs/extensions/code_hilite.md | 216 ++++++++++ docs/extensions/code_hilite.txt | 210 ---------- docs/extensions/definition_lists.md | 52 +++ docs/extensions/definition_lists.txt | 53 --- docs/extensions/extra.md | 148 +++++++ docs/extensions/extra.txt | 147 ------- docs/extensions/fenced_code_blocks.md | 116 ++++++ docs/extensions/fenced_code_blocks.txt | 112 ----- docs/extensions/footnotes.md | 87 ++++ docs/extensions/footnotes.txt | 88 ---- docs/extensions/header_id.md | 131 ++++++ docs/extensions/header_id.txt | 126 ------ docs/extensions/index.md | 86 ++++ docs/extensions/index.txt | 87 ---- docs/extensions/meta_data.md | 110 +++++ docs/extensions/meta_data.txt | 111 ----- docs/extensions/nl2br.md | 35 ++ docs/extensions/nl2br.txt | 37 -- docs/extensions/sane_lists.md | 77 ++++ docs/extensions/sane_lists.txt | 73 ---- docs/extensions/smart_strong.md | 39 ++ docs/extensions/smart_strong.txt | 41 -- docs/extensions/smarty.md | 78 ++++ docs/extensions/smarty.txt | 80 ---- docs/extensions/tables.md | 58 +++ docs/extensions/tables.txt | 58 --- docs/extensions/toc.md | 136 +++++++ docs/extensions/toc.txt | 127 ------ docs/extensions/wikilinks.md | 148 +++++++ docs/extensions/wikilinks.txt | 135 ------- docs/favicon.ico | Bin 0 -> 15086 bytes docs/index.md | 111 +++++ docs/index.txt | 115 ------ docs/install.md | 73 ++++ docs/install.txt | 67 --- docs/reference.md | 367 +++++++++++++++++ docs/reference.txt | 325 --------------- docs/release-2.0.1.txt | 22 - docs/release-2.0.2.txt | 15 - docs/release-2.0.txt | 73 ---- docs/release-2.1.0.txt | 122 ------ docs/release-2.1.1.txt | 13 - docs/release-2.2.0.txt | 68 ---- docs/release-2.2.1.txt | 12 - docs/release-2.3.txt | 88 ---- docs/release-2.4.txt | 77 ---- docs/release-2.5.txt | 187 --------- docs/release-2.6.txt | 263 ------------ docs/siteindex.txt | 78 ---- docs/test_suite.md | 138 +++++++ docs/test_suite.txt | 138 ------- makefile | 5 +- markdown/__init__.py | 2 +- markdown/__main__.py | 2 +- markdown/extensions/abbr.py | 2 +- markdown/extensions/admonition.py | 2 +- markdown/extensions/attr_list.py | 2 +- markdown/extensions/codehilite.py | 2 +- markdown/extensions/def_list.py | 2 +- markdown/extensions/extra.py | 2 +- markdown/extensions/fenced_code.py | 2 +- markdown/extensions/footnotes.py | 2 +- markdown/extensions/headerid.py | 2 +- markdown/extensions/meta.py | 2 +- markdown/extensions/nl2br.py | 2 +- markdown/extensions/sane_lists.py | 2 +- markdown/extensions/smart_strong.py | 2 +- markdown/extensions/smarty.py | 2 +- markdown/extensions/tables.py | 2 +- markdown/extensions/toc.py | 2 +- markdown/extensions/wikilinks.py | 2 +- mkdocs.yml | 57 +++ setup.py | 158 +------- test-requirements.txt | 3 +- tests/misc/em-around-links.html | 10 +- tests/misc/em-around-links.txt | 10 +- 106 files changed, 4660 insertions(+), 5496 deletions(-) delete mode 100644 docs/_template.html create mode 100644 docs/authors.md delete mode 100644 docs/authors.txt delete mode 100644 docs/basic.css delete mode 100644 docs/change_log.txt create mode 100644 docs/change_log/index.md create mode 100644 docs/change_log/release-2.0.md create mode 100644 docs/change_log/release-2.1.md create mode 100644 docs/change_log/release-2.2.md create mode 100644 docs/change_log/release-2.3.md create mode 100644 docs/change_log/release-2.4.md create mode 100644 docs/change_log/release-2.5.md create mode 100644 docs/change_log/release-2.6.md create mode 100644 docs/cli.md delete mode 100644 docs/cli.txt delete mode 100644 docs/default.css create mode 100644 docs/extensions/abbreviations.md delete mode 100644 docs/extensions/abbreviations.txt create mode 100644 docs/extensions/admonition.md delete mode 100644 docs/extensions/admonition.txt create mode 100644 docs/extensions/api.md delete mode 100644 docs/extensions/api.txt create mode 100644 docs/extensions/attr_list.md delete mode 100644 docs/extensions/attr_list.txt create mode 100644 docs/extensions/code_hilite.md delete mode 100644 docs/extensions/code_hilite.txt create mode 100644 docs/extensions/definition_lists.md delete mode 100644 docs/extensions/definition_lists.txt create mode 100644 docs/extensions/extra.md delete mode 100644 docs/extensions/extra.txt create mode 100644 docs/extensions/fenced_code_blocks.md delete mode 100644 docs/extensions/fenced_code_blocks.txt create mode 100644 docs/extensions/footnotes.md delete mode 100644 docs/extensions/footnotes.txt create mode 100644 docs/extensions/header_id.md delete mode 100644 docs/extensions/header_id.txt create mode 100644 docs/extensions/index.md delete mode 100644 docs/extensions/index.txt create mode 100644 docs/extensions/meta_data.md delete mode 100644 docs/extensions/meta_data.txt create mode 100644 docs/extensions/nl2br.md delete mode 100644 docs/extensions/nl2br.txt create mode 100644 docs/extensions/sane_lists.md delete mode 100644 docs/extensions/sane_lists.txt create mode 100644 docs/extensions/smart_strong.md delete mode 100644 docs/extensions/smart_strong.txt create mode 100644 docs/extensions/smarty.md delete mode 100644 docs/extensions/smarty.txt create mode 100644 docs/extensions/tables.md delete mode 100644 docs/extensions/tables.txt create mode 100644 docs/extensions/toc.md delete mode 100644 docs/extensions/toc.txt create mode 100644 docs/extensions/wikilinks.md delete mode 100644 docs/extensions/wikilinks.txt create mode 100644 docs/favicon.ico create mode 100644 docs/index.md delete mode 100644 docs/index.txt create mode 100644 docs/install.md delete mode 100644 docs/install.txt create mode 100644 docs/reference.md delete mode 100644 docs/reference.txt delete mode 100644 docs/release-2.0.1.txt delete mode 100644 docs/release-2.0.2.txt delete mode 100644 docs/release-2.0.txt delete mode 100644 docs/release-2.1.0.txt delete mode 100644 docs/release-2.1.1.txt delete mode 100644 docs/release-2.2.0.txt delete mode 100644 docs/release-2.2.1.txt delete mode 100644 docs/release-2.3.txt delete mode 100644 docs/release-2.4.txt delete mode 100644 docs/release-2.5.txt delete mode 100644 docs/release-2.6.txt delete mode 100644 docs/siteindex.txt create mode 100644 docs/test_suite.md delete mode 100644 docs/test_suite.txt create mode 100644 mkdocs.yml diff --git a/.gitignore b/.gitignore index 6ac9fff..96c6778 100644 --- a/.gitignore +++ b/.gitignore @@ -6,6 +6,7 @@ test-output.html build/* dist/* tmp/* +site/* MANIFEST .venv *~ diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index e8679d6..10044e4 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -41,7 +41,6 @@ is deemed necessary and appropriate to the circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter of an incident. - This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.3.0, available at [http://contributor-covenant.org/version/1/3/0/][version] diff --git a/INSTALL.md b/INSTALL.md index 6e6ab8c..a314fb6 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -5,5 +5,5 @@ As an Admin/Root user on your system do: pip install markdown -Or for more specific instructions, view the documentation in `docs/install.txt` -or on the website at . +Or for more specific instructions, view the documentation in `docs/install.md` +or on the website at . diff --git a/LICENSE.md b/LICENSE.md index 4cd8b14..2652d97 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,20 +1,20 @@ -Copyright 2007, 2008 The Python Markdown Project (v. 1.7 and later) -Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b) -Copyright 2004 Manfred Stienstra (the original version) +Copyright 2007, 2008 The Python Markdown Project (v. 1.7 and later) +Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b) +Copyright 2004 Manfred Stienstra (the original version) 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. -* Neither the name of the nor the - names of its contributors may be used to endorse or promote products - derived from this software without specific prior written permission. + +* 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. +* Neither the name of the Python Markdown Project nor the + names of its contributors may be used to endorse or promote products + derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE PYTHON MARKDOWN PROJECT ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED @@ -27,4 +27,3 @@ 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/README.md b/README.md index 5e8dc84..33b4f71 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,56 @@ [Python-Markdown][] =================== -[![Build Status](http://img.shields.io/travis/Python-Markdown/markdown.svg)](https://travis-ci.org/Python-Markdown/markdown) -[![Coverage Status](https://codecov.io/gh/Python-Markdown/markdown/branch/master/graph/badge.svg)](https://codecov.io/gh/Python-Markdown/markdown) -[![Latest Version](http://img.shields.io/pypi/v/Markdown.svg)](http://pypi.python.org/pypi/Markdown) -[![Python Versions](http://img.shields.io/pypi/pyversions/Markdown.svg)](http://pypi.python.org/pypi/Markdown) -[![BSD License](http://img.shields.io/badge/license-BSD-yellow.svg)](http://opensource.org/licenses/BSD-3-Clause) -[![Code of Conduct](https://img.shields.io/badge/code%20of%20conduct-contributor%20covenant-green.svg?style=flat-square)][Code of Conduct] - -This is a Python implementation of John Gruber's [Markdown][]. +[![Build Status][travis-button]][travis] +[![Coverage Status][codecov-button]][codecov] +[![Latest Version][mdversion-button]][md-pypi] +[![Python Versions][pyversion-button]][md-pypi] +[![BSD License][bsdlicense-button]][bsdlicense] +[![Code of Conduct][codeofconduct-button]][Code of Conduct] + +[travis-button]: http://img.shields.io/travis/Python-Markdown/markdown.svg +[travis]: https://travis-ci.org/Python-Markdown/markdown +[codecov-button]: https://codecov.io/gh/Python-Markdown/markdown/branch/master/graph/badge.svg +[codecov]: https://codecov.io/gh/Python-Markdown/markdown +[mdversion-button]: http://img.shields.io/pypi/v/Markdown.svg +[md-pypi]: http://pypi.python.org/pypi/Markdown +[pyversion-button]: http://img.shields.io/pypi/pyversions/Markdown.svg +[bsdlicense-button]: http://img.shields.io/badge/license-BSD-yellow.svg +[bsdlicense]: http://opensource.org/licenses/BSD-3-Clause +[codeofconduct-button]: https://img.shields.io/badge/code%20of%20conduct-contributor%20covenant-green.svg?style=flat-square +[Code of Conduct]: https://github.com/Python-Markdown/markdown/blob/master/CODE_OF_CONDUCT.md + +This is a Python implementation of John Gruber's [Markdown][]. It is almost completely compliant with the reference implementation, -though there are a few known issues. See [Features][] for information -on what exactly is supported and what is not. Additional features are +though there are a few known issues. See [Features][] for information +on what exactly is supported and what is not. Additional features are supported by the [Available Extensions][]. -[Python-Markdown]: https://pythonhosted.org/Markdown/ +[Python-Markdown]: https://Python-Markdown.github.io/ [Markdown]: http://daringfireball.net/projects/markdown/ -[Features]: https://pythonhosted.org/Markdown/index.html#Features -[Available Extensions]: https://pythonhosted.org/Markdown/extensions/index.html - +[Features]: https://Python-Markdown.github.io#Features +[Available Extensions]: https://Python-Markdown.github.io/extensions Documentation ------------- Installation and usage documentation is available in the `docs/` directory -of the distribution and on the project website at -. +of the distribution and on the project website at +. -See the change log at . +See the change log at . Support ------- -You may ask for help and discuss various other issues on the [mailing list][] and report bugs on the [bug tracker][]. +You may ask for help and discuss various other issues on the [mailing list][] +and report bugs on the [bug tracker][]. [mailing list]: http://lists.sourceforge.net/lists/listinfo/python-markdown-discuss -[bug tracker]: http://github.com/Python-Markdown/markdown/issues +[bug tracker]: http://github.com/Python-Markdown/markdown/issues Code of Conduct --------------- -Everyone interacting in the Python-Markdown project's codebases, issue trackers, and mailing lists is expected to follow the [Code of Conduct]. - -[Code of Conduct]: https://github.com/Python-Markdown/markdown/blob/master/CODE_OF_CONDUCT.md +Everyone interacting in the Python-Markdown project's codebases, issue trackers, +and mailing lists is expected to follow the [Code of Conduct]. diff --git a/checkspelling.sh b/checkspelling.sh index 4ae20cc..654fef0 100755 --- a/checkspelling.sh +++ b/checkspelling.sh @@ -1,14 +1,14 @@ #!/bin/bash echo "Building docs..." -python setup.py --quiet build_docs --force +mkdocs build --clean echo "Compiling Dictionary..." aspell --lang=en create master ./tmp <.spell-dict -echo "Checking spelling...\n" +echo "Checking spelling..." let "fails=0" -for file in $(find build/docs/ -type f -name "*.html"); do +for file in $(find site/ -type f -name "*.html"); do words=$(aspell list --lang=en --mode=html --add-html-skip=code --extra-dicts=./tmp <$file) if [ "$words" ]; then uniquewords=$(tr ' ' '\n' <<< "${words[@]}" | sort -u | tr '\n' ' ') @@ -22,7 +22,7 @@ for file in $(find build/docs/ -type f -name "*.html"); do fi done rm -f ./tmp -rm -rf build +rm -rf site if [ $fails -gt 0 ]; then echo "$fails files with misspelled words." diff --git a/docs/_template.html b/docs/_template.html deleted file mode 100644 index 58e9967..0000000 --- a/docs/_template.html +++ /dev/null @@ -1,81 +0,0 @@ - - - - -%(page_title)s - - - - -
-

Navigation

- -
- -
-
-
-
-%(body)s -
-
-
- -
-
-

Table Of Contents

- %(toc)s - -

Previous topic

-

%(prev_title)s

-

Next topic

-

%(next_title)s

-

This Page

- -
-
- -
-
- -
-

Navigation

- -
- -
© 2010-2012 Python Markdown Project
- - diff --git a/docs/authors.md b/docs/authors.md new file mode 100644 index 0000000..658707d --- /dev/null +++ b/docs/authors.md @@ -0,0 +1,58 @@ +title: Authors + +Primary Authors +=============== + +* __[Waylan Limberg](http://achinghead.com/)__ + + Waylan is the current maintainer of the code and has written much of the + current code base, included a complete refactor of the core. He started out + by authoring many of the available extensions and later was asked to join + Yuri, where he began fixing numerous bugs, adding documentation and making + general improvements to the existing code base. + +* __[Yuri Takteyev](http://freewisdom.org/)__ + + Yuri wrote most of the code found in version 1.x while procrastinating his + Ph.D. Various pieces of his code still exist, most notably the basic + structure. + +* __[Manfed Stienstra](http://www.dwerg.net/)__ + + Manfed wrote the original version of the script and is responsible for + various parts of the existing code base. + +* __Artem Yunusov__ + + Artem, who as part of a 2008 GSoC project, refactored inline patterns, + replaced the NanoDOM with ElementTree support and made various other + improvements. + +* __David Wolever__ + + David refactored the extension API and made other improvements + as he helped to integrate Markdown into Dr.Project. + +Other Contributors +================== + +The incomplete list of individuals below have provided patches or otherwise +contributed to the project in various ways. We would like to thank everyone +who has contributed to the project in any way. + +* Eric Abrahamsen +* Jeff Balogh +* Sergej Chodarev +* Chris Clark +* Tiago Cogumbreiro +* Kjell Magne Fauske +* G. Clark Haynes +* Daniel Krech +* Steward Midwinter +* Jack Miller +* Neale Pickett +* Paul Stansifer +* John Szakmeister +* Malcolm Tredinnick +* Ben Wilson +* and many others who helped by reporting bugs diff --git a/docs/authors.txt b/docs/authors.txt deleted file mode 100644 index 84c69d0..0000000 --- a/docs/authors.txt +++ /dev/null @@ -1,60 +0,0 @@ -title: Authors -prev_title: Release Notes for v2.0 -prev_url: release-2.0.html -next_title: Table of Contents -next_url: siteindex.html - -Primary Authors -=============== - -[Yuri Takteyev](http://freewisdom.org/) - -: Yuri has written much of the current code while procrastinating his Ph.D. - -[Waylan Limberg](http://achinghead.com/) - -: Waylan is the current maintainer of the code and has written much the current - code base, included a complete refactor of the core. He started out by - authoring many of the available extensions and later was asked to join Yuri, - where he began fixing numerous bugs, adding documentation and making general - improvements to the existing code base. - -Artem Yunusov - -: Artem, who as part of a 2008 GSoC project, refactored inline patterns, - replaced the NanoDOM with ElementTree support and made various other - improvements. - -[Manfed Stienstra](http://www.dwerg.net/) - -: Manfed wrote the original version of the script and is responsible for - various parts of the existing code base. - -David Wolever - -: David refactored the extension API and made other improvements - as he helped to integrate Markdown into Dr.Project. - -Other Contributors -================== - -The incomplete list of individuals below have provided patches or otherwise -contributed to the project in various ways. We would like to thank everyone -who has contributed to the project in any way. - -* Eric Abrahamsen -* Jeff Balogh -* Sergej Chodarev -* Chris Clark -* Tiago Cogumbreiro -* Kjell Magne Fauske -* G. Clark Haynes -* Daniel Krech -* Steward Midwinter -* Jack Miller -* Neale Pickett -* Paul Stansifer -* John Szakmeister -* Malcolm Tredinnick -* Ben Wilson -* and many others who helped by reporting bugs diff --git a/docs/basic.css b/docs/basic.css deleted file mode 100644 index 3f7ad80..0000000 --- a/docs/basic.css +++ /dev/null @@ -1,445 +0,0 @@ -/** - * Sphinx stylesheet -- basic theme - * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - */ - -/* -- main layout ----------------------------------------------------------- */ - -div.clearer { - clear: both; -} - -/* -- relbar ---------------------------------------------------------------- */ - -div.related { - width: 100%; - font-size: 90%; -} - -div.related h3 { - display: none; -} - -div.related ul { - margin: 0; - padding: 0 0 0 10px; - list-style: none; -} - -div.related li { - display: inline; -} - -div.related li.right { - float: right; - margin-right: 5px; -} - -/* -- sidebar --------------------------------------------------------------- */ - -div.sphinxsidebarwrapper { - padding: 10px 5px 0 10px; -} - -div.sphinxsidebar { - float: left; - width: 230px; - margin-left: -100%; - font-size: 90%; -} - -div.sphinxsidebar ul { - list-style: none; -} - -div.sphinxsidebar ul ul, -div.sphinxsidebar ul.want-points { - margin-left: 20px; - list-style: square; -} - -div.sphinxsidebar ul ul { - margin-top: 0; - margin-bottom: 0; -} - -div.sphinxsidebar form { - margin-top: 10px; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - -img { - border: 0; -} - -/* -- search page ----------------------------------------------------------- */ - -ul.search { - margin: 10px 0 0 20px; - padding: 0; -} - -ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; -} - -ul.search li a { - font-weight: bold; -} - -ul.search li div.context { - color: #888; - margin: 2px 0 0 30px; - text-align: left; -} - -ul.keywordmatches li.goodmatch a { - font-weight: bold; -} - -/* -- index page ------------------------------------------------------------ */ - -table.contentstable { - width: 90%; -} - -table.contentstable p.biglink { - line-height: 150%; -} - -a.biglink { - font-size: 1.3em; -} - -span.linkdescr { - font-style: italic; - padding-top: 5px; - font-size: 90%; -} - -/* -- general index --------------------------------------------------------- */ - -table.indextable td { - text-align: left; - vertical-align: top; -} - -table.indextable dl, table.indextable dd { - margin-top: 0; - margin-bottom: 0; -} - -table.indextable tr.pcap { - height: 10px; -} - -table.indextable tr.cap { - margin-top: 10px; - background-color: #f2f2f2; -} - -img.toggler { - margin-right: 3px; - margin-top: 3px; - cursor: pointer; -} - -/* -- general body styles --------------------------------------------------- */ - -a.headerlink { - visibility: hidden; -} - -h1:hover > a.headerlink, -h2:hover > a.headerlink, -h3:hover > a.headerlink, -h4:hover > a.headerlink, -h5:hover > a.headerlink, -h6:hover > a.headerlink, -dt:hover > a.headerlink { - visibility: visible; -} - -div.body p.caption { - text-align: inherit; -} - -div.body td { - text-align: left; -} - -.field-list ul { - padding-left: 1em; -} - -.first { - margin-top: 0 !important; -} - -p.rubric { - margin-top: 30px; - font-weight: bold; -} - -/* -- sidebars -------------------------------------------------------------- */ - -div.sidebar { - margin: 0 0 0.5em 1em; - border: 1px solid #ddb; - padding: 7px 7px 0 7px; - background-color: #ffe; - width: 40%; - float: right; -} - -p.sidebar-title { - font-weight: bold; -} - -/* -- topics ---------------------------------------------------------------- */ - -div.topic { - border: 1px solid #ccc; - padding: 7px 7px 0 7px; - margin: 10px 0 10px 0; -} - -p.topic-title { - font-size: 1.1em; - font-weight: bold; - margin-top: 10px; -} - -/* -- admonitions ----------------------------------------------------------- */ - -div.admonition { - margin-top: 10px; - margin-bottom: 10px; - padding: 7px; -} - -div.admonition dt { - font-weight: bold; -} - -div.admonition dl { - margin-bottom: 0; -} - -p.admonition-title { - margin: 0px 10px 5px 0px; - font-weight: bold; -} - -div.body p.centered { - text-align: center; - margin-top: 25px; -} - -/* -- tables ---------------------------------------------------------------- */ - -table { - border: 0 solid #dce; - border-collapse: collapse; -} - -table td, table th { - padding: 2px 5px 2px 5px; -} - -table td { - border: 1px solid #ddd; - background-color: #eef; -} - -table td p.last, table th p.last { - margin-bottom: 0; -} - -table.field-list td, table.field-list th { - border: 0 !important; -} - -table.footnote td, table.footnote th { - border: 0 !important; -} - -table th { - border: 1px solid #cac; - background-color: #ede; -} - -th { - text-align: left; - padding-right: 5px; -} - -th.head { - text-align: center; -} - -/* -- other body styles ----------------------------------------------------- */ - -dl { - margin-bottom: 15px; -} - -dd p { - margin-top: 0px; -} - -dd ul, dd table { - margin-bottom: 10px; -} - -dd { - margin-top: 3px; - margin-bottom: 10px; - margin-left: 30px; -} - -dt:target, .highlight { - background-color: #fbe54e; -} - -dl.glossary dt { - font-weight: bold; - font-size: 1.1em; -} - -.field-list ul { - margin: 0; - padding-left: 1em; -} - -.field-list p { - margin: 0; -} - -.refcount { - color: #060; -} - -.optional { - font-size: 1.3em; -} - -.versionmodified { - font-style: italic; -} - -p.deprecated { - background-color: #ffe4e4; - border: 1px solid #f66; - padding: 7px -} - -.system-message { - background-color: #fda; - padding: 5px; - border: 3px solid red; -} - -.footnote:target { - background-color: #ffa; -} - -.impl-detail { - margin-top: 10px; - margin-bottom: 10px; - padding: 7px; - border: 1px solid #ccc; -} - -.impl-detail .compound-first { - margin-top: 0; -} - -.impl-detail .compound-last { - margin-bottom: 0; -} - -/* -- code displays --------------------------------------------------------- */ - -pre { - overflow: auto; - overflow-y: hidden; -} - -code { - font-size: 1.1em; -} - -td.linenos pre { - padding: 5px 0px; - border: 0; - background-color: transparent; - color: #aaa; -} - -table.highlighttable { - margin-left: 0.5em; -} - -table.highlighttable td { - padding: 0 0.5em 0 0.5em; -} - -tt.descname { - background-color: transparent; - font-weight: bold; - font-size: 1.2em; -} - -tt.descclassname { - background-color: transparent; -} - -tt.xref, a tt { - background-color: transparent; - font-weight: bold; -} - -h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { - background-color: transparent; -} - -/* -- math display ---------------------------------------------------------- */ - -img.math { - vertical-align: middle; -} - -div.body div.math p { - text-align: center; -} - -span.eqno { - float: right; -} - -/* -- printout stylesheet --------------------------------------------------- */ - -@media print { - div.document, - div.documentwrapper, - div.bodywrapper { - margin: 0 !important; - width: 100%; - } - - div.sphinxsidebar, - div.related, - div.footer, - #top-link { - display: none; - } -} diff --git a/docs/change_log.txt b/docs/change_log.txt deleted file mode 100644 index c9478a2..0000000 --- a/docs/change_log.txt +++ /dev/null @@ -1,230 +0,0 @@ -title: Change Log -prev_title: Test Suite -prev_url: test_suite.html -next_title: Release Notes for v2.6 -next_url: release-2.6.html - -Python-Markdown Change Log -========================= - -Aug 17, 2017: Released version 2.6.9 (a bug-fix release). - -Jan 25, 2017: Released version 2.6.8 (a bug-fix release). - -Sept 23, 2016: Released version 2.6.7 (a bug-fix release). - -Mar 20, 2016: Released version 2.6.6 (a bug-fix release). - -Nov 24, 2015: Released version 2.6.5 (a bug-fix release). - -Nov 6, 2015: Released version 2.6.4 (a bug-fix release). - -Oct 26, 2015: Released version 2.6.3 (a bug-fix release). - -Apr 20, 2015: Released version 2.6.2 (a bug-fix release). - -Mar 8, 2015: Released version 2.6.1 (a bug-fix release). The (new) -`yaml` option has been removed from the Meta-Data Extension as it was buggy -(see [#390](https://github.com/Python-Markdown/markdown/issues/390)). - -Feb 19, 2015: Released version 2.6 ([Notes](release-2.6.html)). - -Nov 19, 2014: Released version 2.5.2 (a bug-fix release). - -Sept 26, 2014: Released version 2.5.1 (a bug-fix release). - -Sept 12, 2014: Released version 2.5.0 ([Notes](release-2.5.html)). - -Feb 16, 2014: Released version 2.4.0 ([Notes](release-2.4.html)). - -Mar 22, 2013: Released version 2.3.1 (a bug-fix release). - -Mar 14, 2013: Released version 2.3.0 ([Notes](release-2.3.html)) - -Nov 4, 2012: Released version 2.2.1 ([Notes](release-2.2.1.html)). - -Jul 5, 2012: Released version 2.2.0 ([Notes](release-2.2.0.html)). - -Jan 22, 2012: Released version 2.1.1 ([Notes](release-2.1.1.html)). - -Nov 24, 2011: Released version 2.1.0 ([Notes](release-2.1.0.html)). - -Oct 7, 2009: Released version 2.0.3. - -Sept 28, 2009: Released version 2.0.2 ([Notes](release-2.0.2.html)). - -May 20, 2009: Released version 2.0.1 ([Notes](release-2.0.1.html)). - -Mar 30, 2009: Released version 2.0 ([Notes](release-2.0.html)). - -Mar 8, 2009: Release Candidate 2.0-rc-1. - -Feb 2009: Added support for multi-level lists to new Blockprocessors. - -Jan 2009: Added HTML 4 output as an option (thanks Eric Abrahamsen) - -Nov 2008: Added Definition List ext. Replaced old core with Blockprocessors. -Broken up into multiple files. - -Oct 2008: Changed logging behavior to work better with other systems. -Refactored tree traversing. Added `treap` implementation, then replaced with -OrderedDict. Renamed various processors to better reflect what they actually -do. Refactored footnote ext to match PHP Extra's output. - -Sept 2008: Moved `prettifyTree` to a Postprocessor, replaced WikiLink ext -with WikiLinks (note the s) ext (uses bracketed links instead of CamelCase) -and various bug fixes. - -August 18 2008: Reorganized directory structure. Added a 'docs' directory -and moved all extensions into a 'markdown-extensions' package. -Added additional documentation and a few bug fixes. (v2.0-beta) - -August 4 2008: Updated included extensions to ElementTree. Added a -separate command line script. (v2.0-alpha) - -July 2008: Switched from home-grown NanoDOM to ElementTree and -various related bugs (thanks Artem Yunusov). - -June 2008: Fixed issues with nested inline patterns and cleaned -up testing framework (thanks Artem Yunusov). - -May 2008: Added a number of additional extensions to the -distribution and other minor changes. Moved repository to git from svn. - -Mar 2008: Refactored extension API to accept either an -extension name (as a string) or an instance of an extension -(Thanks David Wolever). Fixed various bugs and added doc strings. - -Feb 2008: Various bug-fixes mostly regarding extensions. - -Feb 18, 2008: Version 1.7. - -Feb 13, 2008: A little code cleanup and better documentation -and inheritance for Preprocessors/Postprocessors. - -Feb 9, 2008: Double-quotes no longer HTML escaped and raw HTML -honors ``, `<@foo>`, and `<%foo>` for those who run markdown on -template syntax. - -Dec 12, 2007: Updated docs. Removed encoding argument from Markdown -and markdown as per list discussion. Clean up in prep for 1.7. - -Nov 29, 2007: Added support for images inside links. Also fixed -a few bugs in the footnote extension. - -Nov 19, 2007: `message` now uses python's logging module. Also removed -limit imposed by recursion in `_process_section()`. You can now parse as -long of a document as your memory can handle. - -Nov 5, 2007: Moved `safe_mode` code to a `textPostprocessor` and added -escaping option. - -Nov 3, 2007: Fixed convert method to accept empty strings. - -Oct 30, 2007: Fixed `BOM` removal (thanks Malcolm Tredinnick). Fixed -infinite loop in bracket regular expression for inline links. - -Oct 11, 2007: `LineBreaks` is now an `inlinePattern`. Fixed `HR` in -blockquotes. Refactored `_processSection` method (see tracker #1793419). - -Oct 9, 2007: Added `textPreprocessor` (from 1.6b). - -Oct 8, 2008: Fixed Lazy Blockquote. Fixed code block on first line. -Fixed empty inline image link. - -Oct 7, 2007: Limit recursion on inline patterns. Added a 'safe' tag -to `htmlStash`. - -March 18, 2007: Fixed or merged a bunch of minor bugs, including -multi-line comments and markup inside links. (Tracker #s: 1683066, -1671153, 1661751, 1627935, 1544371, 1458139.) -> v. 1.6b - -Oct 10, 2006: Fixed a bug that caused some text to be lost after -comments. Added "safe mode" (user's HTML tags are removed). - -Sept 6, 2006: Added exception for PHP tags when handling HTML blocks. - -August 7, 2006: Incorporated Sergej Chodarev's patch to fix a problem -with ampersand normalization and HTML blocks. - -July 10, 2006: Switched to using `optparse`. Added proper support for -Unicode. - -July 9, 2006: Fixed the `