Rinx Example Site

Welcome to the Rinx example.

• Section headings
  • Overlined headings
    • Overlined and deep
  • Titles wider than they look
    • 🔍 An emoji-prefixed title
    • 漢字 in a title
  • Inline markup in a title
    • A bold word in a title
  • Underlines that are too short
    • A deliberately under-drawn heading
• Hyperlinks and Targets
  • External Targets
  • Embedded URIs
  • Phrased and Simple Links
  • Case Insensitivity and Normalization
  • Internal References
  • Anonymous Hyperlinks
• Admonitions Showcase
  • Standard Admonitions
  • Generic Admonitions
  • Collapsible Admonitions
  • Nested Content
• Inline Roles
  • Supported Roles
  • Examples
  • Term References (:term:)
  • Reference Role (:ref:)
• Version Change Directives
• See Also Directive
  • Basic Usage
  • Bullet List Body
  • Multiple Paragraphs
  • Empty Body
• Literal Blocks
  • Plain :: Introduction
  • .. code-block:: Directive
• Code Blocks
  • The Language Argument
  • :caption: and :name:
  • :linenos: and :lineno-start:
  • :emphasize-lines:
  • :dedent:
  • :class: and :force:
  • .. highlight::
  • .. code::
• Glossary
  • Sorted Glossary
• Definition Lists
  • Basic Usage
  • Multi-Paragraph Definition
  • Inline Markup in Terms
  • Inside a seealso Directive
• Enumerated Lists
  • Enumeration Sequences
  • Enumerator Formats
  • Auto-Enumeration
  • Starting at Another Number
  • Multi-Line and Multi-Paragraph Items
  • Nested Lists
  • Other Block Content in an Item
  • Lists Inside Directives
  • When a Line Is Not a List
• Option Lists
  • Synonyms and a Space-Delimited Argument
  • An Equals-Delimited Long Option
  • An Adjacent Short Option
  • DOS-Style and Old GNU-Style Markers
  • A Bracketed Placeholder Argument
  • Description Starting on the Next Line
  • A Multi-Paragraph Description
• Block Quotes
  • A Plain Block Quote
  • With a Single-Line Attribution
  • With a Multi-Line Attribution
  • Nested Block Quotes
  • A Block Quote Containing a List
  • A Block Quote Containing a Directive
• Line Blocks
  • A Plain Line Block
  • A Deliberately Blank Line
  • Nesting
  • Multiple Nesting Levels
  • A Wrapped Continuation Line
  • A Line Block Inside a Block Quote
• Comments
• Domains
  • Python Domain
    • Multiple Signatures Per Directive
    • The Greeter Class
      • Legacy .. classmethod:: / .. staticmethod:: Directives
      • Decorator Directives
    • Custom Exceptions
    • Role-Target Aliasing (class / exception)
    • py:data Definitions Inside a Table
    • The greetings Module
    • The :module: Option Override
  • C Domain
  • C Namespaces
  • Cross-References
  • The Flat clock.now Classmethod
  • Target Resolution Order
  • Standard Domain
• Current Module
• Transitions
• Smart Typography
  • Em Dash
  • En Dash
  • Ellipsis
  • Inside Emphasis
  • Not Inside Literals
• Backslash Escapes
  • Escaping Markup Characters
  • The Escaped Space
  • Escapes Are Not Processed in Literals
  • Escaping Typography
  • Escapes in Roles
• Grid Tables
  • Simple Table with a Header
  • Table Without a Header Row
  • Cells Spanning Columns
  • Cells Spanning Rows
  • Hierarchical (Nested) Headers
• Simple Tables
  • Table with a Header
  • Table Without a Header Row
  • Cells as Miniature Documents
  • Cells Spanning Columns
  • The Rightmost Column Is Unbounded
• List Tables
  • Basic List Table
  • Table with a Title
  • :header-rows:
  • :stub-columns:
  • :widths:
  • :width:
  • :align:
  • :class:
  • :name: and Cross-Referencing
  • Domain Objects Nested Inside a Cell
• CSV Tables
  • Basic CSV Table
  • Table with a Title
  • :header-rows:
  • :header:
  • :stub-columns:
  • :widths:
  • :width:
  • :align:
  • :class:
  • :name: and Cross-Referencing
  • Quoting
  • :delim:
  • :quote:
  • :escape:
  • :keepspace:
  • :file:
  • Ragged Rows
  • RST Inside a Cell
• The table Directive
  • Wrapping a Grid Table
  • Wrapping a Simple Table
  • Table with a Title
  • :widths:
  • :width:
  • :align:
  • :class:
  • :name: and Cross-Referencing
  • Domain Objects Nested Inside a Cell
• Math
  • The :math: Role
  • The .. math:: Directive
  • Several Equations at Once
  • Multi-Line Equations
  • :label: and the :eq: Role
  • :name:
  • :class:
  • :nowrap:
  • Environments
• Images
  • A bare image
  • Alternative text
  • Sizing
  • Alignment
    • Centre alignment
    • Right alignment
  • Making the image a link
  • Referring to an image
  • Classes
  • How the bytes reach the page
  • An external image
  • A source-root-relative path
• Figures
  • A figure with a caption
  • A caption and a legend
  • A legend with no caption
  • Sizing the figure box
  • Alignment
    • Centre alignment
    • Right alignment
  • Classes
  • Referring to a figure
  • A figure that is also a link
  • An embedded figure
  • A figure with no body
• Substitutions
  • Simple text substitution
  • Unicode characters
  • Inline images
• Includes
  • Including reStructuredText
  • Selecting part of a fragment
  • Including a file verbatim
  • Including source files
    • Selecting lines
    • Framing the excerpt
    • Showing a change
    • Line numbers and captions
• Index Entries
  • Single Entries
  • Single Entries with a Subentry
  • Pair Entries
  • Triple Entries
  • Comma-Shorthand Entries
  • Main Entries
• Suppressing diagnostics
  • Suppressing one code
  • Suppressing several codes at once
  • Suppressing everything in a block
  • Suppressing a parse-time diagnostic
  • Nesting
  • Math warnings
  • Mistyped codes
• Unrecognized and malformed directives
  • An unrecognized name
  • A recognized name this build had to refuse
  • The suppression silences the warning, not the block
• Conditional content by builder
  • A block for this builder
  • A block for another builder
  • The body is spliced, not wrapped
  • A heading written inside the block
  • Nested blocks
  • What is reported
• Doctest Directives
  • Interactive examples
  • Separate code and output
  • Named groups
  • Setup and cleanup
  • Hidden blocks
  • Comparison options
  • Doctest flag comments
  • Blocks without a directive
  • Conditional execution
• Entities
  • Requirements
    • An entity with every kind of declaration
    • Attribute defaults and a generated id
    • Specifications and implementations
    • A one-directional relation and a required one
    • Referring to entities from prose
  • Audit events
  • Listing entities
    • Every entity in the project
    • Choosing columns
    • Filtering
    • Sorting and layout
  • Charting the graph
    • Counting by type
    • A legend and colours of your own
    • Scoping a whole chart once
    • Numbers written outright
    • Bar charts
      • Labels, axis titles and turned text
      • Horizontal, transposed, and numbers written outright
      • Scoping a whole bar chart once
    • When nothing matches
  • Importing from sphinx-needs
    • Importing a whole file
    • Imported entities are ordinary entities
    • Importing by name
    • Choosing a version
    • Narrowing what is imported
    • Ids the project does not own
    • Tagging an import
    • What is not supported
  • Updating entities after the fact
    • Targeting a single id, appending and removing a tag
    • Targeting a filter, setting a field on every match at once
    • Appending and removing a relation target
    • A target matching nothing
    • Rejected mutations
    • A conflicting pair
  • Diagrams over the entity graph
    • Drawing what a filter selects
    • Reading one entity's fields
    • Extra values
    • An architecture diagram inside an entity
    • Importing another entity's diagram
    • Named PlantUML preambles
    • Flowcharts of the graph itself
      • Selecting a subgraph, and labelling its edges
      • The generated source, and a preamble
    • Sequence diagrams of the graph
      • Selecting receivers, and capping the picture
• Toctree Directives
  • Numbering
    • 1. First Numbered Chapter
      • 1.1. Installing
        • 1.1.1. From Source
      • 1.2. Configuring
    • 2. Second Numbered Chapter
      • 2.1. Usage
    • 3. Third Numbered Chapter
      • 3.1. Configuring
  • Depth limits
    • Titles Only
      • First Section
      • Second Section
    • Entry Forms
      • Relative and absolute
      • Nested sections
        • Deeper still
    • Titles Only
      • First Section
      • Second Section
  • Globs and ordering
    • Globbed Beta
    • Globbed Alpha
  • Hidden
  • Overview of this page
  • Entry Forms
    • Relative and absolute
    • Nested sections
      • Deeper still
  • Renamed in the sidebar
    • First Section
    • Second Section
  • https://www.sphinx-doc.org/
• Contents Directives
  • Explicit title
    • Explicit Title Target
  • Depth limit
    • Depth Target
      • Deeper Still
  • Local
    • Nested One
    • Nested Two
  • Backlinks
    • Entry, the default
      • Entry Target
    • Top
      • Top Target
    • None
      • None Target
  • Class and name
    • Named Target
• Sectnum Directives
  • Default numbering
  • Depth limit
  • Start value
  • Prefix and suffix
  • Precedence with :numbered:
  • Default Numbering
    • 1. Installing
      • 1.1. From Source
    • 2. Configuring
  • Depth Limit
    • 1. Installing
      • From Source
    • 2. Configuring
  • Start Value
    • 5. Installing
    • 6. Configuring
  • Prefix and Suffix
    • 1. Installing
    • 2. Configuring
• Dropdown Directives
  • Basics
  • Colours
  • Icons
  • Markers and animation
  • Spacing and classes
  • Cross-references
  • Dropdown Basics
  • Dropdown Colours
  • Dropdown Icons
  • Dropdown Markers and Animation
  • Dropdown Spacing and Classes
  • Referring to a Dropdown
• Grid Directives
  • Columns
  • Spacing
  • Alignment
  • Nesting
  • Columns
    • The argument
    • The :columns: option
  • Spacing
    • :gutter:
    • :margin: and :padding:
  • Alignment
    • :child-direction:
    • :child-align:
    • :reverse:
    • :class-container:, :class-row: and :class:
  • Nesting
    • A diagram in a cell
    • Other constructs in a cell
    • A grid inside a grid
• Button Link Directives
  • Basics
  • Colours
  • Layout
  • Diagnostics
  • Basics
  • Colours
    • Filled
    • Outlined
  • Layout
    • Alignment
    • Expanding
    • Shadow and tooltip
    • Clickable parent
    • Extra classes
  • Diagnostics
    • A missing argument
    • An unreadable colour
    • An unreadable alignment
    • An outline with no colour
    • An option that belongs on the other button
    • A reference inside the label
    • An option with no value
    • An unknown option
• 🧩 Templated Sources
  • Including a shared fragment
  • Where a diagnostic points
  • What is refused
  • Generating Repetitive Content
  • Jinja That Is Not Jinja
• Linking into other sites
  • Ordinary roles fall back to the inventory
  • Naming the inventory in the target
  • The :external: roles
  • A local label that shadows Python's
  • An inventory that was never declared
• Team A: Getting Started
  • Installation
• Team B: Infrastructure Guide
  • Overview
  • Configuration

See also Rinx Example Site, Team A: Getting Started, and Team B: Infrastructure Guide.

Bullet List Examples

• Simple item 1

• Simple item 2

  • Nested item A

  • Nested item B

• Simple item 3

Another list with different bullet:

• Plus item 1

• Plus item 2

This is an emphasized word and this is strong emphasis. You can even use (parentheses) or punctuation like bold!

Here is an inline literal: venv or cargo build. Inside the literal, backslashes and other symbols are preserved literally, like **not_bold** or some\path.