Skip to main content
Ctrl+K
PyConverter-XML2Py - Home
  • Getting started
  • User guide
  • API reference
  • Contribute
Ctrl+K
  • GitHub
  • Support
Ctrl+K
  • Getting started
  • User guide
  • API reference
  • Contribute
  • GitHub
  • Support

Section Navigation

  • src.pyconverter.xml2py
    • utils
    • ast_tree
      • NameMap
      • Element
      • ItemizedList
      • SimpleList
      • Member
      • OrderedList
      • ListItem
      • FileName
      • OLink
      • Paragraph
      • Phrase
      • Structname
      • Title
      • Emphasis
      • Example
      • InformalExample
      • GuiMenu
      • Replaceable
      • ProgramListing
      • Variablelist
      • RefSection
      • VarlistEntry
      • Term
      • GuiLabel
      • GuiMenuItem
      • SuperScript
      • Code
      • Math
      • InlineEquation
      • SubScript
      • InlineGraphic
      • Quote
      • Link
      • XRef
      • UserInput
      • Screen
      • Literal
      • Caution
      • Graphic
      • Function
      • Note
      • BlockQuote
      • RefMeta
      • IndexTerm
      • Primary
      • TGroup
      • Table
      • Refentrytitle
      • Refnamediv
      • Refname
      • Refpurpose
      • Refclass
      • Application
      • Refsect1
      • Command
      • ComputerOutput
      • Figure
      • Footnote
      • Footnoteref
      • Formalpara
      • Glossterm
      • GuiButton
      • GuiIcon
      • Highlights
      • Important
      • InformalEquation
      • Interface
      • Markup
      • Mediaobject
      • Option
      • Refsect3
      • Refsynopsisdiv
      • Sidebar
      • XMLType
      • XMLWarning
      • ClassName
      • Imageobject
      • InformalFigure
      • Envar
      • ImageData
      • ColSpec
      • TBody
      • Entry
      • Row
      • THead
      • Remark
      • LiteralLayout
      • CiteTitle
      • ULink
      • SegTitle
      • Chapter
      • Section1
      • ProductName
      • ArgumentList
      • Argument
      • XMLCommand
      • InformalTable
      • OxygenXmlTree
    • cli
    • custom_functions
    • directory_format
    • download
    • formatter
    • load_xml_doc
    • version_variables
    • writer
  • PyAnsys
  • API reference
  • The src.pyconverter.xml2py library
  • The ast_tree.py module
  • OLink

OLink#

class src.pyconverter.xml2py.ast_tree.OLink(element)#

Bases: Element

Provides the external link element.

Overview#

to_rst

Return a string to enable converting the element to an RST format.

targetptr

Value for the targetptr contained in the OLink element.

targetdoc

Value for the targetdoc parameter contained in the OLink element.

Import detail#

from src.pyconverter.xml2py.ast_tree import OLink

Property detail#

property OLink.targetptr#

Value for the targetptr contained in the OLink element.

property OLink.targetdoc#

Value for the targetdoc parameter contained in the OLink element.

Method detail#

OLink.to_rst(indent='', max_length=100, links=None, base_url=None)#

Return a string to enable converting the element to an RST format.

On this page
  • src.pyconverter.xml2py.ast_tree.OLink
  • Overview
  • Import detail
  • Property detail
    • targetptr
    • targetdoc
  • Method detail
    • to_rst()
Edit on GitHub
Show Source

© Copyright (c) 2024 ANSYS, Inc. All rights reserved.

Created using Sphinx 8.0.2.

Built with the Ansys Sphinx Theme 1.1.5.
Last updated on