Skip to content
Permalink
Browse files

fix up documentation

  • Loading branch information...
dcolish committed Jul 22, 2010
1 parent 74ad82d commit cd55d1e706905586c154f2ff1eb1f517341ee2ad
Showing with 38 additions and 16 deletions.
  1. +2 −0 .gitignore
  2. +11 −3 docs/conf.py
  3. +18 −13 docs/index.rst
  4. +7 −0 setup.cfg
@@ -0,0 +1,2 @@
docs/_build
Flask_Markdown.egg-info
@@ -17,16 +17,16 @@
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.append(os.path.abspath('_themes'))
sys.path.append(os.path.abspath('..'))

# -- General configuration -----------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = []

extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

@@ -166,6 +166,9 @@
# Output file base name for HTML help builder.
htmlhelp_basename = 'FlaskMarkdowndoc'

html_theme_options = {
'github_fork': 'dcolish/flask-markdown',
}

# -- Options for LaTeX output --------------------------------------------------

@@ -213,4 +216,9 @@
man_pages = [
('index', 'flaskmarkdown', u'Flask Markdown Documentation',
[u'Dan Colish'], 1)
]
]

intersphinx_mapping = {
'http://docs.python.org/': None,
'http://flask.pocoo.org/docs': None
}
@@ -1,10 +1,15 @@
Welcome to Flask Markdown's documentation!
==========================================

.. module:: flaskext.markdown


Flask-Markdown adds support for `Markdown`_ to your `Flask`_
application. There is little to no documentation for it, but
it works just the same as markdown would normally.

All source code can be found at `Github`_


Installation
------------
@@ -20,12 +25,15 @@ or alternatively if you have pip installed::
How to Use
----------

To use::
To use you must construct a :class:`Markdown` with your
:class:`~flask.Flask` instance.
::

from flaskext.markdown import Markdown
md = Markdown(app)

Then in your template::
Then in your template
::

{% filter markdown %}
Your Markdown
@@ -34,17 +42,14 @@ How to Use

You can also do::

{{ mymarkdown | markdown}}

Contents:

.. toctree::
:maxdepth: 2
{{ mkd|markdown }}

Indices and tables
==================
API Reference
-------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. autoclass:: Markdown
:members:

.. _`Flask`: http://flask.pocoo.org/
.. _`Markdown`: http://www.freewisdom.org/projects/python-markdown/
.. _`Github`: http://www.github.com/dcolish/flask-markdown
@@ -0,0 +1,7 @@
[build_sphinx]
source-dir = docs/
build-dir = docs/_build
all_files = 1

[upload_sphinx]
upload-dir = docs/_build/html

0 comments on commit cd55d1e

Please sign in to comment.
You can’t perform that action at this time.