workaround_recommonmark_issue_191.MdInclude Class Reference

Inheritance diagram for workaround_recommonmark_issue_191.MdInclude:

Collaboration diagram for workaround_recommonmark_issue_191.MdInclude:

Public Member Functions
def	run (self)

Static Public Attributes
dictionary	option_spec
int	optional_arguments = 0
int	required_arguments = 1

Detailed Description

Directive class to include markdown in sphinx.
Load a file and convert it to rst and insert as a node. Currently
directive-specific options are not implemented.
See https://github.com/sphinx-doc/sphinx/issues/7000
and https://github.com/readthedocs/recommonmark/issues/191

Definition at line 11 of file workaround_recommonmark_issue_191.py.

Member Function Documentation

run()

def workaround_recommonmark_issue_191.MdInclude.run

(

self

)

Most of this method is from ``docutils.parser.rst.Directive``.
docutils version: 0.12

Definition at line 25 of file workaround_recommonmark_issue_191.py.

Member Data Documentation

option_spec

dictionary workaround_recommonmark_issue_191.MdInclude.option_spec

static

Initial value:

=  {
        'start-line': int,
        'end-line': int,
    }

Definition at line 20 of file workaround_recommonmark_issue_191.py.

optional_arguments

int workaround_recommonmark_issue_191.MdInclude.optional_arguments = 0

static

Definition at line 19 of file workaround_recommonmark_issue_191.py.

required_arguments

int workaround_recommonmark_issue_191.MdInclude.required_arguments = 1

static

Definition at line 18 of file workaround_recommonmark_issue_191.py.

---

The documentation for this class was generated from the following file:

• Docs/_sphinxext/workaround_recommonmark_issue_191.py