File: api.rst

package info (click to toggle)
md-toc 9.0.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,192 kB
  • sloc: python: 7,901; sh: 942; makefile: 21
file content (49 lines) | stat: -rw-r--r-- 1,233 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
Developer Interface
===================

Functions
---------

.. important:: If you are a developer and you need a quick way to generate
               a TOC, the function you may want to use is `build_toc <#md_toc.api.build_toc>`_

.. autosummary::
   :nosignatures:
   :recursive:

   md_toc.api.get_atx_heading
   md_toc.api.get_md_header
   md_toc.api.build_toc_line
   md_toc.api.increase_index_ordered_list
   md_toc.api.anchor_link_punctuation_filter
   md_toc.api.build_anchor_link
   md_toc.api.build_toc
   md_toc.api.build_multiple_tocs
   md_toc.api.write_string_on_file_between_markers
   md_toc.api.write_strings_on_files_between_markers
   md_toc.api.init_indentation_log
   md_toc.api.compute_toc_line_indentation_spaces
   md_toc.api.build_toc_line_without_indentation
   md_toc.api.is_valid_code_fence_indent
   md_toc.api.is_opening_code_fence
   md_toc.api.is_closing_code_fence
   md_toc.api.tocs_equal
   md_toc.api.remove_html_tags
   md_toc.api.remove_emphasis
   md_toc.api.replace_and_split_newlines
   md_toc.api.filter_indices_from_line

.. automodule:: md_toc.api
   :members:

Exceptions
----------

.. automodule:: md_toc.exceptions
   :members:

Types
-----

.. automodule:: md_toc.types
   :members: