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. --- 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 +- 19 files changed, 19 insertions(+), 19 deletions(-) (limited to 'markdown') diff --git a/markdown/__init__.py b/markdown/__init__.py index 409f9cf..5b8be47 100644 --- a/markdown/__init__.py +++ b/markdown/__init__.py @@ -10,7 +10,7 @@ called from the command line. import markdown html = markdown.markdown(your_text_string) -See for more +See for more information and instructions on how to extend the functionality of Python Markdown. Read that before you try modifying this file. diff --git a/markdown/__main__.py b/markdown/__main__.py index 17bfa9f..c24f756 100644 --- a/markdown/__main__.py +++ b/markdown/__main__.py @@ -27,7 +27,7 @@ def parse_options(args=None, values=None): usage = """%prog [options] [INPUTFILE] (STDIN is assumed if no INPUTFILE is given)""" desc = "A Python implementation of John Gruber's Markdown. " \ - "https://pythonhosted.org/Markdown/" + "https://Python-Markdown.github.io/" ver = "%%prog %s" % markdown.version parser = optparse.OptionParser(usage=usage, description=desc, version=ver) diff --git a/markdown/extensions/abbr.py b/markdown/extensions/abbr.py index 353d126..bfa8c10 100644 --- a/markdown/extensions/abbr.py +++ b/markdown/extensions/abbr.py @@ -4,7 +4,7 @@ Abbreviation Extension for Python-Markdown This extension adds abbreviation handling to Python-Markdown. -See +See for documentation. Oringinal code Copyright 2007-2008 [Waylan Limberg](http://achinghead.com/) and diff --git a/markdown/extensions/admonition.py b/markdown/extensions/admonition.py index 0c5ce46..2e83900 100644 --- a/markdown/extensions/admonition.py +++ b/markdown/extensions/admonition.py @@ -6,7 +6,7 @@ Adds rST-style admonitions. Inspired by [rST][] feature with the same name. [rST]: http://docutils.sourceforge.net/docs/ref/rst/directives.html#specific-admonitions # noqa -See +See for documentation. Original code Copyright [Tiago Serafim](http://www.tiagoserafim.com/). diff --git a/markdown/extensions/attr_list.py b/markdown/extensions/attr_list.py index a7f92b6..894e545 100644 --- a/markdown/extensions/attr_list.py +++ b/markdown/extensions/attr_list.py @@ -6,7 +6,7 @@ Adds attribute list syntax. Inspired by [maruku](http://maruku.rubyforge.org/proposal.html#attribute_lists)'s feature of the same name. -See +See for documentation. Original code Copyright 2011 [Waylan Limberg](http://achinghead.com/). diff --git a/markdown/extensions/codehilite.py b/markdown/extensions/codehilite.py index 20b889c..ee42d57 100644 --- a/markdown/extensions/codehilite.py +++ b/markdown/extensions/codehilite.py @@ -4,7 +4,7 @@ CodeHilite Extension for Python-Markdown Adds code/syntax highlighting to standard Python-Markdown code blocks. -See +See for documentation. Original code Copyright 2006-2008 [Waylan Limberg](http://achinghead.com/). diff --git a/markdown/extensions/def_list.py b/markdown/extensions/def_list.py index 77cca6e..9057ebd 100644 --- a/markdown/extensions/def_list.py +++ b/markdown/extensions/def_list.py @@ -4,7 +4,7 @@ Definition List Extension for Python-Markdown Adds parsing of Definition Lists to Python-Markdown. -See +See for documentation. Original code Copyright 2008 [Waylan Limberg](http://achinghead.com) diff --git a/markdown/extensions/extra.py b/markdown/extensions/extra.py index de5db03..587ba64 100644 --- a/markdown/extensions/extra.py +++ b/markdown/extensions/extra.py @@ -20,7 +20,7 @@ under a differant name. You could also edit the `extensions` global variable defined below, but be aware that such changes may be lost when you upgrade to any future version of Python-Markdown. -See +See for documentation. Copyright The Python Markdown Project diff --git a/markdown/extensions/fenced_code.py b/markdown/extensions/fenced_code.py index 277bac4..392c654 100644 --- a/markdown/extensions/fenced_code.py +++ b/markdown/extensions/fenced_code.py @@ -4,7 +4,7 @@ Fenced Code Extension for Python Markdown This extension adds Fenced Code Blocks to Python-Markdown. -See +See for documentation. Original code Copyright 2007-2008 [Waylan Limberg](http://achinghead.com/). diff --git a/markdown/extensions/footnotes.py b/markdown/extensions/footnotes.py index 8bd8595..7edf813 100644 --- a/markdown/extensions/footnotes.py +++ b/markdown/extensions/footnotes.py @@ -4,7 +4,7 @@ Footnotes Extension for Python-Markdown Adds footnote handling to Python-Markdown. -See +See for documentation. Copyright The Python Markdown Project diff --git a/markdown/extensions/headerid.py b/markdown/extensions/headerid.py index 2cb20b9..fdcc8f2 100644 --- a/markdown/extensions/headerid.py +++ b/markdown/extensions/headerid.py @@ -4,7 +4,7 @@ HeaderID Extension for Python-Markdown Auto-generate id attributes for HTML headers. -See +See for documentation. Original code Copyright 2007-2011 [Waylan Limberg](http://achinghead.com/). diff --git a/markdown/extensions/meta.py b/markdown/extensions/meta.py index 711235e..7902bd4 100644 --- a/markdown/extensions/meta.py +++ b/markdown/extensions/meta.py @@ -4,7 +4,7 @@ Meta Data Extension for Python-Markdown This extension adds Meta Data handling to markdown. -See +See for documentation. Original code Copyright 2007-2008 [Waylan Limberg](http://achinghead.com). diff --git a/markdown/extensions/nl2br.py b/markdown/extensions/nl2br.py index 8acd60c..a4c0fab 100644 --- a/markdown/extensions/nl2br.py +++ b/markdown/extensions/nl2br.py @@ -5,7 +5,7 @@ NL2BR Extension A Python-Markdown extension to treat newlines as hard breaks; like GitHub-flavored Markdown does. -See +See for documentation. Oringinal code Copyright 2011 [Brian Neal](http://deathofagremmie.com/) diff --git a/markdown/extensions/sane_lists.py b/markdown/extensions/sane_lists.py index 828ae7a..651b12b 100644 --- a/markdown/extensions/sane_lists.py +++ b/markdown/extensions/sane_lists.py @@ -4,7 +4,7 @@ Sane List Extension for Python-Markdown Modify the behavior of Lists in Python-Markdown to act in a sane manor. -See +See for documentation. Original code Copyright 2011 [Waylan Limberg](http://achinghead.com) diff --git a/markdown/extensions/smart_strong.py b/markdown/extensions/smart_strong.py index 58570bb..eeded31 100644 --- a/markdown/extensions/smart_strong.py +++ b/markdown/extensions/smart_strong.py @@ -4,7 +4,7 @@ Smart_Strong Extension for Python-Markdown This extention adds smarter handling of double underscores within words. -See +See for documentation. Original code Copyright 2011 [Waylan Limberg](http://achinghead.com) diff --git a/markdown/extensions/smarty.py b/markdown/extensions/smarty.py index 600d74c..5031bc4 100644 --- a/markdown/extensions/smarty.py +++ b/markdown/extensions/smarty.py @@ -6,7 +6,7 @@ Smarty extension for Python-Markdown Adds conversion of ASCII dashes, quotes and ellipses to their HTML entity equivalents. -See +See for documentation. Author: 2013, Dmitry Shachnev diff --git a/markdown/extensions/tables.py b/markdown/extensions/tables.py index ec3b6ac..6d28aef 100644 --- a/markdown/extensions/tables.py +++ b/markdown/extensions/tables.py @@ -4,7 +4,7 @@ Tables Extension for Python-Markdown Added parsing of tables to Python-Markdown. -See +See for documentation. Original code Copyright 2009 [Waylan Limberg](http://achinghead.com) diff --git a/markdown/extensions/toc.py b/markdown/extensions/toc.py index 56db33c..2c4a4b5 100644 --- a/markdown/extensions/toc.py +++ b/markdown/extensions/toc.py @@ -2,7 +2,7 @@ Table of Contents Extension for Python-Markdown =============================================== -See +See for documentation. Oringinal code Copyright 2008 [Jack Miller](http://codezen.org) diff --git a/markdown/extensions/wikilinks.py b/markdown/extensions/wikilinks.py index 94e1b67..ff16494 100644 --- a/markdown/extensions/wikilinks.py +++ b/markdown/extensions/wikilinks.py @@ -4,7 +4,7 @@ WikiLinks Extension for Python-Markdown Converts [[WikiLinks]] to relative links. -See +See for documentation. Original code Copyright [Waylan Limberg](http://achinghead.com/). -- cgit v1.2.3