Guides

ClassDirective extends SubDirective
in package

FinalYes

A directive that parses the sub block and call the processSub that can be overloaded, like :

.. sub-directive:: Some block of code

You can imagine anything here, like adding emphasis, lists or titles

Table of Contents

Properties

$startingRule  : Rule

Methods

__construct()  : mixed
getAliases()  : array<string|int, string>
When the default domain contains a class directive, this directive will be shadowed. Therefore, Sphinx re-exports it as rst-class.
getName()  : string
Get the directive name
process()  : Node|null
This is the function called by the parser to process the directive, it can be overloaded to do anything with the document, like tweaking nodes or change the parser context
processNode()  : Node
This can be overloaded to write a directive that just create one node for the document, which is common
getStartingRule()  : Rule<string|int, CollectionNode>
optionsToArray()  : array<string, scalar|null>
processSub()  : Node|null
setNodesClasses()  : void

Properties

Methods

getAliases()

When the default domain contains a class directive, this directive will be shadowed. Therefore, Sphinx re-exports it as rst-class.

public getAliases() : array<string|int, string>

See https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#rstclass

Return values
array<string|int, string>

getName()

Get the directive name

public getName() : string
Return values
string

process()

This is the function called by the parser to process the directive, it can be overloaded to do anything with the document, like tweaking nodes or change the parser context

public final process(BlockContext $blockContext, Directive $directive) : Node|null
Parameters
$blockContext : BlockContext

the current document context with the content of the directive

$directive : Directive

parsed directive containing options and variable

Return values
Node|null

processNode()

This can be overloaded to write a directive that just create one node for the document, which is common

public processNode(BlockContext $blockContext, Directive $directive) : Node

The arguments are the same that process

Parameters
$blockContext : BlockContext
$directive : Directive
Return values
Node

optionsToArray()

protected optionsToArray(array<string|int, DirectiveOption> $options) : array<string, scalar|null>
Parameters
$options : array<string|int, DirectiveOption>
Return values
array<string, scalar|null>

setNodesClasses()

private setNodesClasses(array<string|int, Node> $nodes, array<string|int, string> $classes) : void
Parameters
$nodes : array<string|int, Node>
$classes : array<string|int, string> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results