File: interface.rst

package info (click to toggle)
pymarkups 4.1.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 276 kB
  • sloc: python: 1,156; sh: 7; makefile: 3
file content (19 lines) | stat: -rw-r--r-- 662 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
================
Markup interface
================

The main class for interacting with markups is :class:`~markups.abstract.AbstractMarkup`.

However, you shouldn't create direct instances of that class. Instead, use one of the
:doc:`standard markup classes <standard_markups>`.

.. autoclass:: markups.abstract.AbstractMarkup
   :members:

When :class:`~markups.abstract.AbstractMarkup`'s
:meth:`~markups.abstract.AbstractMarkup.convert` method is called it will
return an instance of :class:`~markups.abstract.ConvertedMarkup` or a subclass
thereof that provides access to the conversion results.

.. autoclass:: markups.abstract.ConvertedMarkup
   :members: