Guides

phpDocumentor

Table of Contents

Interfaces

FileSystem

SpecificationFactoryInterface

Interface for Specifications used to filter the FileSystem.

StorageAttributes

CompilerContextInterface

CompilerPass

NodeTransformer

NodeTransformerFactory

ReverseNodeTransformer

Reverse NodeTransformers are applied with child nodes first, then the parent node.

SubNodeAccessor

Describes one edge type of the node tree: where child nodes of an owner are stored, and how a child is replaced or removed. Nodes are immutable, so the modifying methods return the new owner.

SubNodeAccessorProvider

MarkupLanguageParser

Target

NodeRenderer

NodeRendererFactory

NodeRendererFactoryAware

PreNodeRenderer

ConsumesDefaultHighlightLanguage

Implement this interface on a Node to let the compiler set the default highlight language on it, as configured by the project settings or the reStructuredText `.. highlight::` directive, whenever the node does not already have an explicit language set.

CrossReferenceNode

A cross-reference node is a link node that can reference targets outside of the current document.

InlineNodeInterface

LinkInlineNode

Language

What a language tag looks like, for everything that accepts one.

LinkTargetNode

MultipleLinkTargetsNode

Node

OptionalLinkTargetsNode

Makes the implementing node an optional link target. If Noindex is true no references are generated, there is no entry in the objects index and no warning about duplicate ids.

PrefixedLinkTargetNode

AnchorNormalizer

Normalizes raw data used to generate anchors.

DocumentNameResolverInterface

InventoryLinkResolver

InventoryLoader

InventoryRepository

ReferenceResolver

TypeRenderer

TypeRendererFactory

UrlGeneratorInterface

TemplateRenderer

ViolationReporter

Reports the violations found in the documentation source, each implementation in its own way.

ViolationFormat

A format to report the problems found in the documentation source in, in addition to the log.

Highlighter

DiagramRenderer

ParserInterface

Parser

RenderablePageInterface

Common contract for nodes that are rendered as standalone HTML pages outside the main documentation tree.

CodeNodeOptionMapper

The directives `code-block` and `literalinclude` both create a CodeNode with the same possible options.

InterlinkParser

FieldListItemRule

CachableInlineRule

InlineRule

Rule

TextRole

TextRoleFactory

Classes

HttpHandler

WebSocketHandler

Server

ServerFactory

FileModifiedEvent

INotifyWatcher

FileNotFoundException

Exclude

SpecificationFactory

Factory class to build Specification used by FlyFinder when reading files to process.

WithinPath

Matches a path and everything below it, so a directory is matched with all its contents.

FlySystemAdapter

FlysystemV1

StorageAttributes

FileAttributes

FlysystemV3

MethodNotAllowedException

Path

Value Object for paths.

CallableAccessor

CallableListField

A field holding a list of nodes.

ChildrenAccessor

The default field: the ordinary children of a CompoundNode.

Compiler

CompilerContext

Context class used in compiler passes to store the state of the nodes.

CoreProvider

DocumentNodeTraverser

ListAccessor

A field holding nodes keyed by name.

CitationInlineNodeTransformer

CitationTargetTransformer

ClassNodeTransformer

CollectLinkTargetsTransformer

CustomNodeTransformerFactory

DocumentBlockNodeTransformer

DocumentEntryRegistrationTransformer

FootNodeNamedTransformer

FootNodeNumberedTransformer

FootnoteInlineNodeTransformer

HighlightNodeTransformer

Applies the default highlight language, as set by the project settings or the reStructuredText `.. highlight::` directive, to every node implementing {@see ConsumesDefaultHighlightLanguage} that does not already have an explicit language.

ListNodeTransformer

AbstractMenuEntryNodeTransformer

ContentsMenuEntryNodeTransformer

ExternalMenuEntryNodeTransformer

GlobMenuEntryNodeTransformer

InternalMenuEntryNodeTransformer

SubInternalMenuEntryNodeTransformer

TocNodeReplacementTransformer

TocNodeTransformer

ToctreeSortingTransformer

MoveAnchorTransformer

RawNodeEscapeTransformer

SectionCreationTransformer

SectionEntryRegistrationTransformer

TransformerPass

The TransformerPass is a special kind of CompilerPass that traverses all documents and Calls the DocumentNodeTraverser for each.

VariableInlineNodeTransformer

AutomaticMenuPass

GlobalMenuPass

ImplicitHyperlinkTargetPass

Resolves the hyperlink target for each section in the document.

IncludeContentExpansionPass

GenIndexNodeBuilder

Turns a (already see-resolved) term map into a sorted `GenIndexTerm` node tree.

GenIndexRowData

One collected genindex row, before it's turned into a rendered {@see \phpDocumentor\Guides\Nodes\Index\GenIndexRow} node: either a direct link to a section, or a "see"/"seealso" cross-reference to another term.

GenIndexSeeResolver

Points every `see`/`seealso` row at the anchor of the term it targets.

GenIndexTermData

All rows collected for a single genindex term or subterm, before it's turned into a rendered {@see \phpDocumentor\Guides\Nodes\Index\GenIndexTerm} node. Only ever nested one level deep in practice (a subterm's own `subterms` stays empty), the same convention `GenIndexTerm` itself follows.

GenIndexTermMap

Every genindex term collected project-wide, keyed by its normalized term text. Passed between {@see IndexEntryCollector}, {@see GenIndexSeeResolver}, {@see GenIndexTermMapFilter} and {@see GenIndexNodeBuilder} as they collect, resolve, scope and render it in turn.

GenIndexTermMapFilter

Restricts a (already see-resolved) term map to rows originating from a document under one of a set of path prefixes -- used for a `.. genindex::` directive's `:scope:` option.

IndexEntryCollector

Walks every document for `.. index::` entries and expands each one into term/subterm rows, following Sphinx's `pair`/`triple`/`module` conventions.

IndexTargetRegistrar

Makes a named `.. index::` block a target a `:ref:` can link to.

IndexCollectorPass

Collects every `.. index::` entry across all documents and aggregates them into an alphabetically sorted genindex term tree, then makes it available several independent ways -- any combination may be present in a project:

ToctreeValidationPass

TreeNode

SubNodeAccessorRegistry

SubnodeList

CommandLocator

NodeRendererPass

ParserRulesPass

RendererPass

GuidesExtension

TestExtension

Test support for consumers and extensions of phpDocumentor Guides.

ModifyDocumentEntryAdditionalData

PostCollectFilesForParsingEvent

This event is called after all files have been collected for parsing But before the actual parsing begins.

PostParseDocument

This event is called after the parsing of each document is completed by the responsible extension.

PostParseProcess

This event is dispatched right after the overall parsing process is finished, Before the compiler passes, including the node transformers are called.

PostProjectNodeCreated

PostRenderDocument

This event is called after the rendering of each document.

PostRenderProcess

This event is called once after each rendering method after all documents have been rendered.

PreParseDocument

This event is called before the parsing of each document is passed to the responsible extension.

PreParseProcess

This event is dispatched right before the overall parsing process is started.

PreRenderDocument

This event is called before the rendering of each document.

PreRenderProcess

This event is called once before each rendering method after all documents have been parsed and all compiler passes (including node transformers have been called.)

LoadSettingsFromComposer

DocumentEntryNotFound

DuplicateLinkAnchorException

InvalidTableStructure

FileCollector

Files

CompileDocumentsCommand

CompileDocumentsHandler

LoadCacheCommand

LoadCacheHandler

ParseDirectoryCommand

ParseDirectoryHandler

ParseFileCommand

ParseFileHandler

PersistCacheCommand

PersistCacheHandler

RenderCommand

RenderDocumentCommand

RenderDocumentHandler

RenderHandler

DeduplicatingLogger

Suppresses a repeat of a log message already seen, at a configurable granularity -- see {@see LogDeduplicationLevel}.

AnnotationTarget

CitationTarget

ExternalTarget

FootnoteTarget

InternalTarget

DefaultNodeRenderer

DelegatingNodeRenderer

AdmonitionNodeRenderer

BreadCrumbNodeRenderer

DocumentNodeRenderer

MenuEntryRenderer

MenuNodeRenderer

CollectImagesPreNodeRenderer

TableNodeRenderer

TemplateMetadataNodeRenderer

The `:template:` field is a marker consumed by DocumentNode::getTemplate(), not visible content — render it as nothing.

InMemoryNodeRendererFactory

TableNodeRenderer

TitleNodeRenderer

TocNodeRenderer

LazyNodeRendererFactory

OutputAwareDelegatingNodeRenderer

PreNodeRendererFactory

Decorator to add pre-rendering logic to node renderers.

PreRenderer

TemplateNodeRenderer

AbstractNode

AdmonitionNode

AnchorNode

AnnotationListNode

Defines a list of footnotes or citations

AnnotationNode

Defines a footnote or citation

AuthorNode

The author element holds the name of the author of a document, section or code-block

BreadCrumbNode

CitationNode

Defines a citation that can be referenced by an CitationInlineNode

ClassNode

CodeNode

CollectionNode

A collection node is a node that renders all its children without adding a wrap. It is used by directives, that change sub-nodes without having an output of their own, like the class-directive.

CompoundNode

ConfigurationBlockNode

ConfigurationTab

DataNode

A named piece of data attached to another node, rendered as an HTML `data-*` attribute on it.

DefinitionListNode

DefinitionListItemNode

DefinitionNode

DocumentBlockNode

DocumentNode

DocumentEntryNode

EntryNode

ExternalEntryNode

SectionEntryNode

EmbeddedFrame

FieldListNode

FieldListItemNode

FigureNode

FootnoteNode

Defines a footnote that can be referenced by an FootnoteInlineNode

GenericNode

Any Directive not explicitly modeled.

HighlightNode

Marker node to set the default code language.

ImageNode

IncludedContentNode

Contains nodes inserted into a document by an include directive.

GenIndexNode

The genindex content for a page: a term tree collected and populated by IndexCollectorPass, either project-wide (the `:template: genindex` page) or -- when created by GenIndexDirective -- restricted to documents whose path starts with one of $pathPrefixes.

GenIndexRow

One rendered row of a genindex term: either a direct link to a section ("link"), or a "see"/"seealso" cross-reference to another term.

GenIndexTerm

All entries collected for a single genindex term, e.g. "configuration".

IndexEntryNode

One parsed line of a `.. index::` directive, e.g. `single: foo` or `pair: a; b`.

IndexNode

Wraps the entries collected from one `.. index::` directive occurrence.

AbbreviationInlineNode

AbstractLinkInlineNode

AnnotationInlineNode

This node an annotation, for example citation or footnote

CitationInlineNode

This node represents a citation inline a text

DocReferenceNode

Represents a link to document

EmphasisInlineNode

FootnoteInlineNode

This node represents a footnote inline a text

GenericTextRoleInlineNode

HyperLinkNode

Represents a link to an external source or email

ImageInlineNode

In some Markup languages like Markdown Images are always considered inline. They can appear anywhere in a paragraph.

InlineNode

LanguageInlineNode

LiteralInlineNode

NewlineInlineNode

PlainTextInlineNode

ReferenceNode

CrossReferences are references outside a document. As parsing is file based normal references are in document, refering to other documents.

StrongInlineNode

VariableInlineNode

WhitespaceInlineNode

InlineCompoundNode

InvalidLink

Link

ListItemNode

Represents a single item of a bullet or enumerated list.

ListNode

ListItem

LiteralBlockNode

MainNode

MathNode

ContentMenuNode

ExternalMenuEntryNode

GlobMenuEntryNode

Represents a menu entry that can be replaced by multiple InternalMenuEntryNodes during compilation. The url contains a string here. It cannot be rendered.

InternalMenuEntryNode

MenuDefinitionLineNode

This node contains the result of parsing the menu entries for a menu.

MenuEntryNode

MenuNode

NavMenuNode

SectionMenuEntryNode

TocNode

AddressNode

The address element holds the surface mailing address information for the author (individual or group) of the document, or a third-party contact address. Its structure is identical to that of the literal_block element: whitespace is significant, especially newlines.

AuthorNode

The author element holds the name of the author of the document.

AuthorsNode

The authors element is a container for author information for documents with multiple authors.

ContactNode

The contact element holds contact information for the author (individual or group) of the document, or a third-party contact. It is typically used for an email or web address.

CopyrightNode

The copyright element contains the document's copyright statement.

DateNode

The date node contains the date of publication, release, or last modification of the document.

DirectionNode

Sets the text direction of the document, e.g. `:dir: rtl`, used as the HTML dir attribute.

LanguageNode

Sets the language of the document, e.g. `:lang: ar`, used as the HTML lang attribute.

MetadataNode

MetaNode

NavigationTitleNode

The organization element contains the name of document author's organization, or the organization responsible for the document.

NoCommentsNode

If set, the web application won’t display a comment form for a page generated from this source file

NoSearchNode

If set, full text search for this file is disabled.

OrganizationNode

The organization element contains the name of document author's organization, or the organization responsible for the document.

OrphanNode

If set, warnings about this file not being included in any toctree will be suppressed.

RevisionNode

The revision element contains the revision number of the document. It can be used alone or in conjunction with version.

TemplateNode

Selects an alternate template for rendering the document, e.g. `:template: genindex`.

TocDepthNode

The maximum depth for a table of contents of this file.

TopicNode

The topic element is a nonrecursive section-like construct which may occur at the top level of a section wherever a body element (list, table, etc.) is allowed. In other words, topic elements cannot nest inside body elements, so you can't have a topic inside a table or a list, or inside another topic.

VersionNode

The version element contains the version number of the document. It can be used alone or in conjunction with revision.

ParagraphNode

ProjectNode

QuoteNode

RawNode

ReplacementNode

SectionNode

SeparatorNode

SpanNode

TableColumn

TableRow

TableNode

The cells of the header rows and then of the data rows are the children of the table, so that the compiler processes their content, such as the directives that are created at compile time.

TextNode

TitleNode

Parser

Determines the correct markup language parser to use based on the input and output format and with it, and parses the file contents.

ParserContext

AnchorHyperlinkResolver

Resolves references with an anchor URL.

AnchorReferenceResolver

Resolves references with an anchor URL.

DelegatingReferenceResolver

Resolves the URL for all inline link nodes using reference resolvers.

DocReferenceResolver

DocumentNameResolver

EmailReferenceResolver

Resolves references with an embedded email address

ExternalReferenceResolver

Resolves references with an embedded external URL.

ImageReferenceResolverPreRender

ChainedInventoryLinkResolver

DefaultInventoryLoader

DefaultInventoryRepository

InvalidInventoryLink

Inventory

InventoryGroup

InventoryLink

JsonLoader

InterlinkReferenceResolver

InternalReferenceResolver

Message

Messages

NullAnchorNormalizer

PageHyperlinkResolver

Resolves named and anonymous references to source files

ReferenceResolverPreRender

SluggerAnchorNormalizer

TitleReferenceResolver

Resolves references with an anchor URL.

RenderContext

BaseTypeRenderer

DocumentListIterator

HtmlRenderer

InMemoryRendererFactory

InterlinkObjectsRenderer

LatexRenderer

AbsoluteUrlGenerator

AbstractUrlGenerator

ConfigurableUrlGenerator

InvalidUrlException

ExternalUrlGenerator

Prefixes internal URLs (non-documents) with a pre-defined base URI.

RelativeUrlGenerator

ComposerSettingsLoader

ProjectSettings

SettingsManager

AssetsExtension

EnvironmentBuilder

GlobalMenuExtension

ThemeConfig

ThemeManager

TrimFilesystemLoader

A file system loader that trims the last line ending from the template content.

TwigTemplateRenderer

UriFactory

CompositeViolationReporter

Passes each violation on to all the given reporters, for example to log it and to annotate a pull request.

LoggingViolationReporter

Passes each violation on to a logger right away, with the same message and context as before violations existed.

NullViolationReporter

Ignores all violations, for when nobody is interested in them.

Violation

A problem in the documentation source, like markup that is ignored or a directive used incorrectly.

Application

Run

Serve

WorkingDirectorySwitcher

Configuration

XmlFileLoader

ApplicationExtension

ContainerFactory

RerenderListener

RunCommand

RunCommandHandler

AnnotationDetails

Where a violation is found and what it says, as code review tools show it on the lines of a change.

GithubActionsViolationFormat

Prints the violations as GitHub Actions workflow commands, which GitHub shows as annotations on a pull request.

GitlabViolationFormat

Writes the violations to a code quality report, which GitLab shows in a merge request and on the lines of its diff.

ViolationFormats

Passes each violation on to the format chosen with the "violation-format" setting, out of all formats registered with the tag "phpdoc.guides.violation_format".

CodeExtension

HighlightPhpHighlighter

This class delegates to the Highlighter library the task of highlighting code blocks, adds extra features, and makes sure that errors result in a log line instead of an exception.

HighlightResult

CodeExtension

Configuration

GraphsExtension

UmlDirective

Renders a uml diagram, example:

UmlNode

PlantumlRenderer

PlantumlServerRenderer

TestRenderer

UmlExtension

MachineReadableExtension

Symfony DI extension for the guides-machine-readable package.

ModifyTocPageEntry

One page of "toc.json", before it is written.

ModifyTocProjectInfo

The "project" section of "toc.json", before it is written.

AddTocOutputFormat

Render the table of contents beside whatever else the project renders.

DocumentOutputFiles

The files one page of the manual was rendered to.

TocRenderer

The table of contents of a manual as one JSON file.

PageDescriptor

One page of "toc.json": where it is, which files it was rendered to, its title and its anchor, and the pages its table of contents leads to.

TocProject

What "toc.json" says about the manual itself, once: its title and version, and whatever a theme adds with {@see TocProject::setExtra()}.

MarkdownExtension

MarkupLanguageParser

NullNode

ParserException

AbstractBlockParser

BlockQuoteParser

CodeBlockParser

AuthorParser

TitleParser

FrontMatterParser

HeaderParser

HtmlParser

AbstractInlineParser

AbstractInlineTextDecoratorParser

EmphasisParser

InlineCodeParser

InlineImageParser

LinkParser

NewLineParser

PlainTextParser

StrongParser

ListBlockParser

ListItemParser

ParagraphParser

SeparatorParser

TableParser

Collection

Value object representing a single content-type collection as configured in `guides.xml`.

Configuration

Symfony Config definition for the guides-pages extension.

PagesExtension

Symfony DI extension for the guides-pages package.

ParseContentTypeListener

Parses and compiles content-type collection items after the main documentation has been parsed.

ParsePagesListener

Parses and compiles standalone pages after the main documentation has been parsed.

RenderPagesListener

Renders all standalone pages and content-type items — including overview pages — after the main documentation has been rendered.

PageNodeRenderer

Renders any {@see RenderablePageInterface} node — static pages, content-type items, and collection overview pages — for the "page" output format.

ContentTypeItemNode

Root AST node for a single item inside a content-type collection.

ContentTypeOverviewNode

Synthetic node representing the auto-generated overview/listing page for a content-type collection (e.g. a "News" index listing all news items).

ContentTypeTemplateNode

Carries a per-item Twig template path override declared in a content-type item source file via the `:page-template:` RST field-list entry.

PageDestinationNode

Declares the output path for a standalone page.

PageNode

Root AST node for a standalone page.

PagesRegistry

Shared state carrier between the parse and render event listeners.

PageRenderer

Renders every parsed document as a standalone HTML page (format: "page").

ContentTypeTemplateRule

RST field-list rule that converts a `:page-template: path/to/template.html.twig` entry into a {@see ContentTypeTemplateNode}.

PageDestinationRule

ReadOptionReturnTypeExtension

DirectiveProcessPass

RestructuredTextProvider

TextRolePass

ReStructuredTextExtension

AbstractAdmonitionDirective

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

AbstractVersionChangeDirective

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

ActionDirective

Extend this class to create a directive that does some actions, for example on the parser context, without creating a node.

AdmonitionDirective

A generic admonition.

AttentionDirective

Directive to create an attention admonition.

Directive

Option

BaseDirective

A directive is like a function you can call or apply to a block It looks like:

BreadcrumbDirective

The "breadcrumb" directive displays a breadcrumb of the current. It does not exist in Sphinx or the reST standard yet.

CautionDirective

Directive to create a caution admonition.

ClassDirective

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

CodeBlockDirective

Renders a code block, example:

ConfigurationBlockDirective

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

ConfvalDirective

The confval directive configuration values.

ContainerDirective

Divs a sub document in a div with a given class or set of classes.

ContentsDirective

Standarad rst `contents` directive

CsvTableDirective

Render csv file as table

DangerDirective

Directive to create a danger admonition.

DefaultRoleDirective

sets the default interpreted text role, the role that is used for interpreted text without an explicit role.

DeprecatedDirective

This directive is used to document that a feature was deprecated in a specific version.

DocumentBlockDirective

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

EpigraphDirective

An epigraph is an apposite (suitable, apt, or pertinent) short inscription, often a quotation or poem, at the beginning of a document or section.

ErrorDirective

Directive to create a error admonition.

FigureDirective

Renders an image, example :

GeneralDirective

A catch-all directive, the content is treated as content, the options passed on

GenIndexDirective

Renders a genindex term listing wherever it's placed, optionally scoped to documents under one or more path prefixes -- unlike the project-wide `:template: genindex` page, this can be dropped inline anywhere and used more than once, e.g. one per version directory in a changelog:

HighlightDirective

https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-highlight

HighlightsDirective

Highlights summarize the main points of a document or section, often consisting of a list.

HintDirective

Directive to create a hint admonition.

ImageDirective

Renders an image, example :

ImportantDirective

Directive to create a important admonition.

IncludeDirective

A directive is like a function you can call or apply to a block It looks like:

IndexDirective

Collects index entries, example:

LaTeXMain

Marks the document as LaTeX main

ListTableDirective

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

LiteralincludeDirective

A directive is like a function you can call or apply to a block It looks like:

MathDirective

Renders a code block, example:

MenuDirective

A menu directives displays a menu in the page. In opposition to a toctree directive the menu is for display only. It does not change the position of document in the document tree and can therefore be included all pages as navigation.

MetaDirective

Add a meta information:

NoteDirective

Directive to create a note admonition.

OptionDirective

Describes a command line argument or switch. Option argument names should be enclosed in angle brackets.

DefaultCodeNodeOptionMapper

The directives `code-block` and `literalinclude` both create a CodeNode with the same possible options.

PullQuoteDirective

A pull-quote is a small selection of text "pulled out and quoted", typically in a larger typeface. Pull-quotes are used to attract attention, especially in long articles.

RawDirective

Renders a raw block, example:

ReplaceDirective

The Replace directive will set the variables for the spans

RoleDirective

The "role" directive dynamically creates a custom interpreted text role and registers it with the parser.

SectionauthorDirective

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

SeeAlsoDirective

Directive to create a seealso admonition.

SidebarDirective

Divs a sub document in a div with a given class or set of classes.

SubDirective

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

TabDirective

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

TableDirective

Applies more options to a table

TabsDirective

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

TestLoggerDirective

Divs a sub document in a div with a given class or set of classes.

TipDirective

Directive to create a tip admonition.

TitleDirective

Add a meta title to the document

ToctreeDirective

Sphinx based Toctree directive.

TodoDirective

Todo directives are treated as comments, omitting all content or options

VersionAddedDirective

This directive is used to document that a feature was added in a specific version.

VersionChangedDirective

This directive is used to document that a feature changed behavior in a specific version.

VersionRemovedDirective

This directive is used to document that a feature was removed in a specific version.

WarningDirective

Directive to create a warning admonition.

YoutubeDirective

This directive is used to embed a youtube video in the document.

MarkupLanguageParser

AdmonitionNodeRenderer

CollectionNodeRenderer

ContainerNodeRenderer

GeneralDirectiveNodeRenderer

SidebarNodeRenderer

TopicNodeRenderer

GeneralDirectiveNodeRenderer

AbstractTabNode

A catch-all directive Node containing all information about the original directive in rst.

AdmonitionNode

ConfvalNode

The confval directive configuration values.

ContainerNode

DirectiveNode

DirectiveSourceLocation

Static facts about where in the source a directive was written -- captured at parse time since createNode() has no access to BlockContext/ DocumentParserContext itself. Covers two needs:

GeneralDirectiveNode

A catch-all directive Node containing all information about the original directive in rst.

OptionNode

Describes a command line argument or switch. Option argument names should be enclosed in angle brackets.

SidebarNode

TabNode

A catch-all directive Node containing all information about the original directive in rst.

TabsNode

A catch-all directive Node containing all information about the original directive in rst.

TopicNode

VersionChangeNode

AnnotationUtility

BlockContext

Our document parser contains

Buffer

Directive

Represents the data contained in an arbitrary directive

DirectiveOption

DocumentParserContext

Our document parser contains

DocumentParserContextFactory

InlineLexer

DefaultInterlinkParser

InterlinkData

LineChecker

LinesIterator

AnnotationRule

BlockQuoteRule

CommentRule

DefinitionListRule

DirectiveContentRule

DirectiveRule

DocumentRule

EnumeratedListRule

AbstractFieldListItemRule

AddressFieldListItemRule

AuthorFieldListItemRule

AuthorsFieldListItemRule

ContactFieldListItemRule

CopyrightFieldListItemRule

DateFieldListItemRule

DedicationFieldListItemRule

DirFieldListItemRule

LangFieldListItemRule

NavigationTitleFieldListItemRule

NocommentsFieldListItemRule

NosearchFieldListItemRule

OrganizationFieldListItemRule

OrphanFieldListItemRule

ProjectFieldListItemRule

RevisionFieldListItemRule

TemplateFieldListItemRule

TocDepthFieldListItemRule

VersionFieldListItemRule

FieldListRule

GridTableRule

InlineMarkupRule

The Inline markup produces inline nodes

AbstractInlineRule

AnnotationRoleRule

Rule to parse for text roles such as ``:ref:`something` `

AnonymousPhraseRule

Rule to parse for anonymous references

AnonymousReferenceRule

Rule to parse for simple anonymous references

DefaultTextRoleRule

Rule to parse for default text roles such as `something`

EmphasisRule

Rule to parse for default text roles such as `something`

EscapeRule

Rule to escape characters with a backslash

InternalReferenceRule

LiteralRule

Rule for literals such as ``something``

NamedPhraseRule

Rule to parse for named references

NamedReferenceRule

Rule to parse for simple named references

NbspRule

Rule to parse for non-breaking spaces: a~b

PlainTextRule

ReferenceRule

StandaloneEmailRule

Rule for standalone hyperlinks

StandaloneHyperlinkRule

Rule for standalone hyperlinks

StrongRule

Rule to parse for default text roles such as `something`

TextRoleRule

Rule to parse for text roles such as ``:ref:`something` `

VariableInlineRule

Rule to parse for inline variables such as |replace_me|

LineBlockRule

LinkRule

ListRule

LiteralBlockRule

ParagraphRule

RuleContainer

SectionRule

SimpleTableRule

GridTableBuilder

ParserContext

TableSeparatorLineConfig

TitleRule

TransitionRule

ReferenceData

ReferenceData

AbbreviationTextRole

Role to create an abbreviation.

AbstractReferenceTextRole

ApiClassTextRole

BaseTextRole

DefaultTextRoleFactory

DocReferenceTextRole

Role to create a reference to a document.

GenericLinkProvider

Role to create references to link targets.

GenericReferenceTextRole

GenericTextRole

LangTextRole

Role to mark text as being in another language and, optionally, another text direction.

LiteralTextRole

Role to create a literal block.

LtrTextRole

MathTextRole

Role to create a math block.

NbspTextRole

Role for inserting a non-breaking space.

ReferenceTextRole

RtlTextRole

SpanTextRole

GlobSearcher

ToctreeBuilder

BootstrapProvider

BootstrapExtension

AccordionDirective

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

AccordionItemDirective

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

CardDirective

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

CardFooterDirective

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

CardGridDirective

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

CardGroupDirective

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

CardHeaderDirective

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

CardImageDirective

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

TabDirective

TabsDirective

AbstractTabNode

AccordionItemNode

A catch-all directive Node containing all information about the original directive in rst.

AccordionNode

A catch-all directive Node containing all information about the original directive in rst.

CardFooterNode

A catch-all directive Node containing all information about the original directive in rst.

CardHeaderNode

A catch-all directive Node containing all information about the original directive in rst.

CardImageNode

A catch-all directive Node containing all information about the original directive in rst.

CardGridNode

A catch-all directive Node containing all information about the original directive in rst.

CardGroupNode

A catch-all directive Node containing all information about the original directive in rst.

CardNode

A catch-all directive Node containing all information about the original directive in rst.

TabNode

TabsNode

RstThemeExtension

RstRenderer

RstExtension

Traits

MenuEntryManagement

SubSectionHierarchyHandler

BCInlineNodeBehavior

ReportsViolations

For classes that took a logger before violations existed, and now accept a ViolationReporter in its place.

EmbeddedReferenceParser

Enums

LogDeduplicationLevel

How aggressively {@see DeduplicatingLogger} collapses repeated log messages, configurable per project via guides.xml's `log-deduplication` attribute.

GenIndexRowKind

Whether a genindex row is a direct link to a section, or a "see"/"seealso" cross-reference to another term.

IndexEntryType

The kind of entry declared in a `.. index::` directive line, e.g. `single: foo` or `pair: a; b`.

TextDirection

The direction a piece of text is read in, as the HTML "dir" attribute spells it.

Severity

How serious a violation is, independent of how it is reported.

DirectiveValueType

The kind of value a directive accepts right after `::`, declared via {@see \phpDocumentor\Guides\RestructuredText\Directives\Attributes\Directive::$valueType}.

OptionType

UnindentStrategy

HeaderSyntax

Functions

templateArray()  : array<string|int, array{node: class-string, file: string, format: string}>

Helper function to configure multiple templates.

template()  : array{node: class-string, file: string, format: string}

Helper function to configure templates.