aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/authors.txt4
-rw-r--r--docs/index.txt4
-rw-r--r--docs/install.txt12
-rw-r--r--docs/reference.txt4
-rw-r--r--docs/siteindex.txt73
5 files changed, 85 insertions, 12 deletions
diff --git a/docs/authors.txt b/docs/authors.txt
index a7ad4cd..53eaaba 100644
--- a/docs/authors.txt
+++ b/docs/authors.txt
@@ -1,8 +1,8 @@
title: Authors
prev_title: Release Notes for v2.0
prev_url: release-2.0.html
-next_title: Summary
-next_url: index.html
+next_title: Table of Contents
+next_url: siteindex.html
Primary Authors
===============
diff --git a/docs/index.txt b/docs/index.txt
index 35c7876..eb245e6 100644
--- a/docs/index.txt
+++ b/docs/index.txt
@@ -1,7 +1,7 @@
next_url: install.html
next_title: Installation
-prev_title: Authors
-prev_url: authors.html
+prev_title: Table of Contents
+prev_url: siteindex.html
Python-Markdown
===============
diff --git a/docs/install.txt b/docs/install.txt
index cb20a73..776bb17 100644
--- a/docs/install.txt
+++ b/docs/install.txt
@@ -21,8 +21,8 @@ or
That's it! Your ready to [use](reference.html) Python-Markdown. Enjoy!
-Installing on Windows
----------------------
+Installing on Windows {: #windows }
+-----------------------------------
Download the Windows installer (.exe) from
[PyPI](http://pypi.python.org/pypi/Markdown)
@@ -41,8 +41,8 @@ the Scripts directory is `C:\PythonXX\Scripts\` (were "XX" is the Python version
number, i.e., "27"). Adjust the path according to your system and add to your
system path.
-Installing on *nix Systems
---------------------------
+Installing on *nix Systems {: #linux }
+--------------------------------------
From the command line do the following (where 2.x is the version number):
@@ -53,8 +53,8 @@ From the command line do the following (where 2.x is the version number):
See [PyPI](http://pypi.python.org/pypi/Markdown) for all available versions.
-Using the Git Repository
-------------------------
+Using the Git Repository {: #git }
+----------------------------------
If you're the type that likes to live on the edge, you may want to keep up with
the latest additions and bug fixes in the repository between releases.
diff --git a/docs/reference.txt b/docs/reference.txt
index c1561f7..b051e92 100644
--- a/docs/reference.txt
+++ b/docs/reference.txt
@@ -210,7 +210,7 @@ as on the [`markdown.markdown`](#markdown) function, except that the class does
**not** accept a source text string on initialization. Rather, the source text
string must be passed to one of two instance methods:
-* `Markdown.convert(source)` {: #convert }
+* `Markdown.convert(source)`{: #convert }
The `source` text must meet the same requirements as the [`text`](#text)
argument of the [`markdown.markdown`](#markdown) function.
@@ -233,7 +233,7 @@ string must be passed to one of two instance methods:
html3 = md.reset().convert(text3)
-* `Markdown.convertFile(**kwargs)` {: #convertFile }
+* `Markdown.convertFile(**kwargs)`{: #convertFile }
The arguments of this method are identical to the arguments of the same
name on the `markdown.markdownFromFile` function ([`input`](#input),
diff --git a/docs/siteindex.txt b/docs/siteindex.txt
new file mode 100644
index 0000000..9c726bd
--- /dev/null
+++ b/docs/siteindex.txt
@@ -0,0 +1,73 @@
+title: Table of Contents
+prev_title: Authors
+prev_url: authors.html
+next_title: Summary
+next_url: index.html
+
+Table of Contents
+=================
+
+* [Python Markdown](index.html)
+ * [Features](index.html#features)
+ * [Support](index.html#support)
+* [Installation](install.html)
+ * [The Easy Way](install.html#the-easy-way)
+ * [Installing on Windows](install.html#windows)
+ * [Installing on *nix Systems](install.html#linux)
+ * [Using the Git Repository](install.html#git)
+ * [Dependencies](install.html#dependencies)
+* [Library Reference](reference.html)
+ * [The Basics](reference.html#the-basics)
+ * [The Details](reference.html#the-details)
+ * [markdown.markdown](reference.html#markdown)
+ * [markdown.markdownFromFile](reference.html#markdownFromFile)
+ * [markdown.Markdown](reference.html#Markdown)
+* [Command Line](cli.html)
+ * [Setup](cli.html#setup)
+ * [Usage](cli.html#usage)
+ * [Using Extensions](cli.html#using-extensions)
+* [Extensions](extensions/index.html)
+ * [Officially Supported Extensions](extensions/index.html#officially-supported-extensions)
+ * [Extra](extensions/extra.html)
+ * [Abbreviations](extensions/abbreviations.html)
+ * [Attribute Lists](extensions/attr_list.html)
+ * [Definition Lists](extensions/definition_lists.html)
+ * [Fenced Code Blocks](extensions/fenced_code_blocks.html)
+ * [Footnotes](extensions/footnotes.html)
+ * [Tables](extensions/tables.html)
+ * [Smart Strong](extensions/smart_strong.html)
+ * [CodeHilite](extensions/code_hilite.html)
+ * [HTML Tidy](extensions/html_tidy.html)
+ * [HeaderId](extensions/header_id.html)
+ * [Meta-Data](extensions/meta_data.html)
+ * [New Line to Break](extensions/nl2br.html)
+ * [RSS](extensions/rss.html)
+ * [Sane Lists](extensions/sane_lists.html)
+ * [Table of Contents](extensions/toc.html)
+ * [WikiLinks](extensions/wikilinks.html)
+ * [Third Party Extensions](extensions/index.html#third-party-extensions)
+ * [Extension API](extensions/api.html)
+ * [Preprocessors](extensions/api.html#preprocessors)
+ * [InlinePatterns](extensions/api.html#inlinepatterns)
+ * [Treeprocessors](extensions/api.html#treeprocessors)
+ * [Postprocessors](extensions/api.html#postprocessors)
+ * [BlockParser](extensions/api.html#blockparser)
+ * [Working with the ElementTree](extensions/api.html#working_with_et)
+ * [Integrating your code into Markdown](extensions/api.html#integrating_into_markdown)
+ * [extendMarkdown](extensions/api.html#extendmarkdown)
+ * [OrderedDict](extensions/api.html#ordereddict)
+ * [registerExtension](extensions/api.html#registerextension)
+ * [Config Settings](extensions/api.html#configsettings)
+ * [makeExtension](extensions/api.html#makeextension)
+* [Test Suite](test_suite.html)
+ * [Markdown Syntax Test](test_suite.html#markdown-syntax-tests)
+ * [Syntax Test Config Settings](test_suite.html#syntax-test-config-settings)
+ * [Unit Tests](test_suite.html#unit-tests)
+ * [Doc Tests](test_suite.html#doc-tests)
+* [Change Log](change_log.html)
+ * [Release Notes for v.2.2.1](release-2.1.1.html)
+ * [Release Notes for v.2.2.0](release-2.1.0.html)
+ * [Release Notes for v.2.0.2](release-2.0.2.html)
+ * [Release Notes for v.2.0.1](release-2.0.1.html)
+ * [Release Notes for v.2.0](release-2.0.html)
+* [Authors](authors.html)