Sphinx Confluence Builder

https://github.com/sphinx-contrib/confluencebuilder
Admin
Sphinx extension to build Confluence-compatible markup and optionally publish to Confluence Cloud or...
Tokens:302,396
Snippets:2,905
Trust Score:9.5
License:BSD-2-Clause
Update:1 month ago
Show doc for...
Tokens:
Raw
### Ubuntu (virtualenv) setup and install

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/install-virtualenv.rst

Install Python and virtualenv using apt-get (with a dnf command for virtualenv), create and activate the virtual environment, install the package, and verify the version. The expected output is 'sphinxcontrib.confluencebuilder <version>'.

```shell-session
$ sudo apt-get update
$ sudo apt-get install python-pip
$ sudo dnf install python-virtualenv
$ virtualenv sphinx-venv
$ source sphinx-venv/bin/activate
$ pip install sphinxcontrib-confluencebuilder
$ python -m sphinxcontrib.confluencebuilder --version
sphinxcontrib.confluencebuilder <version>
```

--------------------------------

### OS X (virtualenv) setup and install

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/install-virtualenv.rst

Install pip and virtualenv using easy_install, create and activate the virtual environment, install the package, and verify the version. The expected output is 'sphinxcontrib.confluencebuilder <version>'.

```shell-session
$ sudo easy_install pip
$ pip install virtualenv
$ virtualenv sphinx-venv
$ source sphinx-venv/bin/activate
$ pip install sphinxcontrib-confluencebuilder
$ python -m sphinxcontrib.confluencebuilder --version
sphinxcontrib.confluencebuilder <version>
```

--------------------------------

### Fedora (virtualenv) setup and install

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/install-virtualenv.rst

Install Python and virtualenv using dnf, create and activate the virtual environment, install the package, and verify the version. The expected output is 'sphinxcontrib.confluencebuilder <version>'.

```shell-session
$ sudo dnf install python-pip
$ sudo dnf install python-virtualenv
$ virtualenv sphinx-venv
$ source sphinx-venv/bin/activate
$ pip install sphinxcontrib-confluencebuilder
$ python -m sphinxcontrib.confluencebuilder --version
sphinxcontrib.confluencebuilder <version>
```

--------------------------------

### Arch (virtualenv) setup and install

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/install-virtualenv.rst

Install Python, pip, and virtualenv using pacman, create an activation script, install the package, and verify the version. The expected output is 'sphinxcontrib.confluencebuilder <version>'.

```shell-session
$ sudo pacman -Sy
$ sudo pacman -S python-pip
$ sudo pacman -S python-virtualenv
$ virtualenv sphinx-venv
$ source sphinx-venv/bin/activate
$ pip install sphinxcontrib-confluencebuilder
$ python -m sphinxcontrib.confluencebuilder --version
sphinxcontrib.confluencebuilder <version>
```

--------------------------------

### Example tenant_info URL

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/guide-scope-token.rst

Example URL showing how to access the tenant info page for a space named 'example'.

```none
https://example.atlassian.net/_edge/tenant_info
```

--------------------------------

### Install sphinxcontrib-confluencebuilder on Windows

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/ipython/install.md

Installation steps for Windows command prompt. Assumes Python is available in the PATH. Uses python -m pip to install and then verifies the installation.

```doscon
> python -m pip install sphinxcontrib-confluencebuilder
> python -m sphinxcontrib.confluencebuilder --version
sphinxcontrib.confluencebuilder <version>

```

--------------------------------

### Install sphinxcontrib-confluencebuilder on OS X

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/ipython/install.md

Installation steps for OS X. Uses sudo easy_install pip, then pip to install the package. The final command verifies the installation and outputs the version.

```shell-session
$ sudo easy_install pip
$ pip install sphinxcontrib-confluencebuilder
$ python -m sphinxcontrib.confluencebuilder --version
sphinxcontrib.confluencebuilder <version>

```

--------------------------------

### Install on Ubuntu

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/install.rst

Commands to install dependencies and the package on Ubuntu.

```shell-session
$ sudo apt-get update
$ sudo apt-get install python-pip
$ pip install sphinxcontrib-confluencebuilder
$ python -m sphinxcontrib.confluencebuilder --version
sphinxcontrib.confluencebuilder <version>
```

--------------------------------

### Install sphinxcontrib-confluencebuilder on Ubuntu

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/ipython/install.md

Platform-specific installation steps for Ubuntu. Uses apt-get to update and install python-pip, then pip to install the package. The final command verifies the installation and outputs the version.

```shell-session
$ sudo apt-get update
$ sudo apt-get install python-pip
$ pip install sphinxcontrib-confluencebuilder
$ python -m sphinxcontrib.confluencebuilder --version
sphinxcontrib.confluencebuilder <version>

```

--------------------------------

### Install on Fedora

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/install.rst

Commands to install dependencies and the package on Fedora.

```shell-session
$ sudo dnf install python-pip
$ pip install sphinxcontrib-confluencebuilder
$ python -m sphinxcontrib.confluencebuilder --version
sphinxcontrib.confluencebuilder <version>
```

--------------------------------

### Install via pip

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/install.rst

Use pip to install or upgrade the package.

```shell
pip install -U sphinxcontrib-confluencebuilder
 (or)
python -m pip install -U sphinxcontrib-confluencebuilder
```

--------------------------------

### Install sphinxcontrib-confluencebuilder on Fedora

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/ipython/install.md

Platform-specific installation steps for Fedora. Uses dnf to install python-pip, then pip to install the package. The final command verifies the installation and outputs the version.

```shell-session
$ sudo dnf install python-pip
$ pip install sphinxcontrib-confluencebuilder
$ python -m sphinxcontrib.confluencebuilder --version
sphinxcontrib.confluencebuilder <version>

```

--------------------------------

### Example confluence_server_url with GUID

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/guide-scope-token.rst

Example configuration using a sample GUID (550e8400-e29b-41d4-a716-446655440000) for the modern API endpoint.

```python
confluence_server_url = 'https://api.atlassian.com/ex/confluence/550e8400-e29b-41d4-a716-446655440000/'
```

--------------------------------

### Install development version

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/install.rst

Install the latest source code directly from the repository.

```shell
pip install git+https://github.com/sphinx-contrib/confluencebuilder.git
```

--------------------------------

### GET /users/(*int:* user_id)/posts/(tag) - Example response

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/httpdomain/index.rst

Example HTTP response with a 200 OK status, returning a JSON array of posts. The Content-Type is text/javascript.

```http
HTTP/1.1 200 OK
Vary: Accept
Content-Type: text/javascript

[
    {
        "post_id": 12345,
        "author_id": 123,
        "tags": ["server", "web"],
        "subject": "I tried Nginx"
    },
    {
        "post_id": 12346,
        "author_id": 123,
        "tags": ["html5", "standards", "web"],
        "subject": "We go to HTML 5"
    }
]
```

--------------------------------

### Install sphinxcontrib-confluencebuilder on Arch Linux

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/ipython/install.md

Platform-specific installation steps for Arch Linux. Uses pacman to install python-pip, then pip to install the package. The final command verifies the installation and outputs the version.

```shell-session
$ sudo pacman -Sy
$ sudo pacman -S python-pip
$ pip install sphinxcontrib-confluencebuilder
$ python -m sphinxcontrib.confluencebuilder --version
sphinxcontrib.confluencebuilder <version>

```

--------------------------------

### Install on Windows

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/install.rst

Commands to install and verify the package on Windows.

```doscon
> python -m pip install sphinxcontrib-confluencebuilder
> python -m sphinxcontrib.confluencebuilder --version
sphinxcontrib.confluencebuilder <version>
```

--------------------------------

### Set modern API endpoint with GUID (template and example)

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/kroki/guide-scope-token.md

Required for scoped tokens. Replace <GUID> with the Cloud identifier from tenant_info. The example shows a GUID placeholder and a real GUID format.

```python
confluence_server_url = 'https://api.atlassian.com/ex/confluence/<GUID>/'

```

```python
confluence_server_url = 'https://api.atlassian.com/ex/confluence/550e8400-e29b-41d4-a716-446655440000/'

```

--------------------------------

### Confluence Cloud Wiki URL Example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/configuration.rst

Example of a standard Confluence Cloud Wiki URL.

```none
https://example.atlassian.net/wiki/
```

--------------------------------

### Verify installation

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/install.rst

Check the installed version of the package.

```shell
python -m sphinxcontrib.confluencebuilder --version
```

--------------------------------

### Bash Script Example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/unit-tests/datasets/code-block/code-block-highlight.rst

A bash script that prints 'this is an example'. The highlighting is explicitly set to bash.

```bash
#!/bin/bash
echo this is an example
```

--------------------------------

### Install bleeding-edge sphinxcontrib-confluencebuilder from git

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/ipython/install.md

Development installation using pip to install directly from the git repository.

```shell
pip install git+https://github.com/sphinx-contrib/confluencebuilder.git

```

--------------------------------

### Sphinx quick-start commands

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/httpdomain/tutorial.md

Run any of these commands in the terminal to start a new Sphinx documentation project.

```shell
sphinx-quickstart
 (or)
python -m sphinx.cmd.quickstart
 (or)
python -m sphinx.quickstart

```

--------------------------------

### start_ac_plain_text_link_body_macro(self, node)

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/next-prev/advanced-extensions.md

Initializes the start of a storage format plain-text-link-body element. Returns content that starts an ac:plain-text-link-body element.

```APIDOC
## start_ac_plain_text_link_body_macro(self, node)

### Description
A helper used to return content to be appended to a document which initializes the start of a storage format plain-text-link-body element. The ac:plain-text-link-body element will be initialized. This method may use provided node to tweak the final content. This call should be used with a respective end_ac_plain_text_link_body_macro() call.

### Parameters
- **node** - The node processing the macro

### Returns
The content
```

--------------------------------

### Create minimalistic conf.py

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/tutorial.rst

Initial content for a new conf.py file in a minimalistic setup.

```python
extensions = []
```

--------------------------------

### GET /users/(*int:* user_id)/posts/(tag) - Example request

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/httpdomain/index.rst

Example HTTP request for retrieving posts by a user and tag. The request includes the Accept header for JSON and text/javascript responses.

```http
GET /users/123/posts/web HTTP/1.1
Host: example.com
Accept: application/json, text/javascript
```

--------------------------------

### Install on OS X

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/install.rst

Commands to install pip and the package on OS X.

```shell-session
$ sudo easy_install pip
$ pip install sphinxcontrib-confluencebuilder
$ python -m sphinxcontrib.confluencebuilder --version
sphinxcontrib.confluencebuilder <version>
```

--------------------------------

### Install on Arch Linux

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/install.rst

Commands to install dependencies and the package on Arch Linux.

```shell-session
$ sudo pacman -Sy
$ sudo pacman -S python-pip
$ pip install sphinxcontrib-confluencebuilder
$ python -m sphinxcontrib.confluencebuilder --version
sphinxcontrib.confluencebuilder <version>
```

--------------------------------

### Example allowed-docs.txt content

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/admonitions/configuration.md

Example content for the file referenced by confluence_publish_allowlist. Lists document names without extensions.

```text
index
foo/bar
```

--------------------------------

### Sphinx seealso directive example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/seealso.md

Example markup for the Sphinx seealso directive, showing how to reference a module and an external manual link.

```none
.. seealso::
    Module `other`
    Documentation of the `other` module.

    `Other Manual <https://www.example.com/manual>`_
    Manual for another reference related to this content.

```

--------------------------------

### hello-world JSON output

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/sphinx-click/index.rst

Example JSON output shown in the documentation for the hello-world command.

```text
{
    "field1": "value1",
    "field2": "value2"
}
```

--------------------------------

### Inline and display math expressions

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/linkcode/math.md

Examples of inline math ($A_\text{c} = (\pi/4) d^2$), display equation ($E = mc^2$), Euler identity with label, and multi-line equation array. Warning: Some math support may require LaTeX and dvipng/dvisvgm installations unless HTML or Marketplace macros are available.

```none
The area of a circle is $A_\text{c} = (\pi/4) d^2$.
```

```none
$$
E = mc^2
$$
```

```none
<a id="equation-euler"></a>
$$
e^{i\pi} + 1 = 0

$$
```

```none
$$
\begin{eqnarray}
   y    & = & ax^2 + bx + c \\
   f(x) & = & x^2 + 2xy + y^2
\end{eqnarray}
$$
```

--------------------------------

### Example denied-docs.txt content

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/latex/configuration.md

Example content for the file referenced by confluence_publish_denylist. Lists document names to deny.

```text
index
foo/bar

```

--------------------------------

### Install sphinxcontrib-confluencebuilder via pip

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/README.md

Use pip to install the extension package.

```shell
pip install sphinxcontrib-confluencebuilder
 (or)
python -m pip install sphinxcontrib-confluencebuilder
```

--------------------------------

### Windows virtualenv installation commands

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/linkcode/install-virtualenv.md

Commands to install virtualenv on Windows, create a virtual environment, activate it, install sphinxcontrib-confluencebuilder, and verify the installation. The first block installs virtualenv; the second block creates and activates the environment and installs the package.

```doscon
> pip install virtualenv
```

```doscon
> virtualenv sphinx-venv
> (or: python -m virtualenv sphinx-venv)
> sphinx-venv\Scripts\activate.bat
> python -m pip install sphinxcontrib-confluencebuilder
> python -m sphinxcontrib.confluencebuilder --version
sphinxcontrib.confluencebuilder <version>
```

--------------------------------

### start_ac_plain_text_link_body_macro(self, node)

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/sphinx-click/advanced-extensions.md

Initializes the start of a storage format plain-text-body element for links. Returns content that starts an ac:plain-text-body element.

```APIDOC
## start_ac_plain_text_link_body_macro(self, node)

### Description
A helper used to return content to be appended to a document which initializes the start of a storage format plain-text-body element. The `ac:plain-text-body` element will be initialized. This method may use provided `node` to tweak the final content. This call should be used with a respective `end_ac_plain_text_link_body_macro()` call.

### Parameters
- **node** - The node processing the macro.

### Returns
The content.
```

--------------------------------

### Example mention role usage

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/markdown-myst/configuration.md

A reStructuredText example showing how to reference a configured mention key in a document.

```rst
For more information, contact :confluence_mention:`myuser`.
```

--------------------------------

### SVG image example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/admonitions/images.md

Example of including an SVG image file.

```markdown
![image](assets/logo.svg)
```

--------------------------------

### Register custom node with Sphinx Confluence Builder

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/advanced-extensions.rst

Example setup function that registers a custom node type with the 'confluence' keyword, along with visit and depart functions that wrap content in [pre] and [post] tags.

```python
def setup(app):
    app.add_node(
        custom_node,
        confluence=(visit_custom_node, depart_custom_node),
    )

def visit_custom_node(self, node):
    self.body.append('[pre]')
    self.context.append('[post]')

def depart_custom_node(self, node):
    self.body.append(self.context.pop())
```

--------------------------------

### start_ac_plain_text_body_macro(self, node)

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/program-output/advanced-extensions.md

Initializes the start of a storage format plain-text-body element. Returns content that sets up an ac:plain-text-body element.

```APIDOC
## start_ac_plain_text_body_macro(self, node)

### Description
Initializes the start of a storage format plain-text-body element. Returns content that sets up an ac:plain-text-body element.

### Method
start_ac_plain_text_body_macro

### Parameters
- **node** - Required - The node processing the macro

### Returns
The content
```

--------------------------------

### Publish Token Environment Variable Setup

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/configuration.rst

Commands to set the publish token via environment variables.

```none
export CONFLUENCE_PUBLISH_TOKEN=TOKEN
 (or)
set CONFLUENCE_PUBLISH_TOKEN=TOKEN
```

--------------------------------

### start_ac_plain_text_link_body_macro(self, node)

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/program-output/advanced-extensions.md

Initializes the start of a storage format plain-text-body element. Returns content that sets up an ac:plain-text-body element.

```APIDOC
## start_ac_plain_text_link_body_macro(self, node)

### Description
Initializes the start of a storage format plain-text-body element. Returns content that sets up an ac:plain-text-body element.

### Method
start_ac_plain_text_link_body_macro

### Parameters
- **node** - Required - The node processing the macro

### Returns
The content
```

--------------------------------

### Literal include example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/validation-sets/sphinx/code.rst

A simple literal include example showing basic print functionality.

```default
print('hello world')
```

--------------------------------

### Minimal Confluence Configuration

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/configuration.rst

A minimal configuration setup for Confluence publishing.

```python
extensions = [
    'sphinxcontrib.confluencebuilder',
]
confluence_publish = True
confluence_space_key = 'MYPRJ'
confluence_server_url = 'https://wiki.example.com/'
confluence_parent_page = 'Documentation'
```

--------------------------------

### Install and upgrade sphinxcontrib-confluencebuilder with pip

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/ipython/install.md

Recommended installation or upgrade method using pip. The -U flag upgrades to the latest version. Alternative form uses python -m pip.

```shell
pip install -U sphinxcontrib-confluencebuilder
 (or)
python -m pip install -U sphinxcontrib-confluencebuilder

```

--------------------------------

### Environment Variable Token Setup

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/configuration.rst

Commands to set the API token via environment variables for authentication.

```none
export CONFLUENCE_API_TOKEN=TOKEN
 (or)
set CONFLUENCE_API_TOKEN=TOKEN
```

--------------------------------

### Literal block output example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/literal-blocks.md

Shows the rendered output of the literal block example. The code is displayed as-is without syntax highlighting.

```default
for a in [5,4,3,2,1]:   # this is program code, shown as-is
    print a
print "it's..."
# a literal block continues until the indentation ends

```

--------------------------------

### todo directive example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/validation-sets/extensions/todo.rst

Shows the syntax for creating a todo entry using the todo directive. Requires registering the sphinx.ext.todo extension and setting the todo_include_todos configuration option.

```none
.. todo::

    This is an example message.
```

--------------------------------

### Non-wrapped math example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/math.md

Display math with an eqnarray environment: $$\begin{eqnarray} ... \end{eqnarray}$$. This is used for multi-line equations.

```latex
$$
\begin{eqnarray}
   y    & = & ax^2 + bx + c \\
   f(x) & = & x^2 + 2xy + y^2
\end{eqnarray}
$$
```

--------------------------------

### Initialize Sphinx project with quick-start

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/tutorial.rst

Commands to initialize a new Sphinx project using the quick-start utility.

```shell
sphinx-quickstart
 (or)
python -m sphinx.cmd.quickstart
 (or)
python -m sphinx.quickstart
```

--------------------------------

### Graphviz directive example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/validation-sets/extensions/graphviz.rst

Shows the basic syntax for the graphviz directive to define a directed graph.

```none
.. graphviz::

    digraph foo {
        "bar" -> "baz";
    }
```

--------------------------------

### reStructuredText option list markup example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/sphinx-data-viewer/option-list.md

Shows the reStructuredText syntax for an option list, using ping command options as an example. The list includes option descriptions and continuation lines.

```none
-a         Audible ping.

-A         Adaptive ping. Interpacket interval adapts to round-trip time,
           so that effectively not more than one (or more, if preload
           is set) unanswered probes present in the network. Minimal
           interval is 200msec for not super-user. On networks with low
           rtt this mode is essentially equivalent to flood mode.

-b         Allow pinging a broadcast address.

...

```

--------------------------------

### Production list markup example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/admonitions/production-list.md

Example markup for the Sphinx production list directive. The directive is used to define grammar productions. The example shows the syntax for try statements.

```none
.. productionlist::
     try_stmt: try1_stmt | try2_stmt
    try1_stmt: "try" ":" `suite`
             : ("except" [`expression` ["," `target`]] ":" `suite`)+
             : ["else" ":" `suite`]
             : ["finally" ":" `suite`]
    try2_stmt: "try" ":" `suite`
             : "finally" ":" `suite`

```

--------------------------------

### Confluence Cloud API Endpoint Example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/configuration.rst

Example of the required API endpoint URL for Confluence Cloud.

```none
https://api.atlassian.com/ex/confluence/550e8400-e29b-41d4-a716-446655440000/
```

--------------------------------

### Configure Confluence publishing settings

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/README.md

Example configuration for enabling publishing and setting target space and server details in conf.py.

```python
extensions = [
    'sphinxcontrib.confluencebuilder',
]
confluence_publish = True
confluence_space_key = 'TEST'
confluence_parent_page = 'Documentation'
confluence_server_url = 'https://intranet-wiki.example.com/'
confluence_ask_user = True
confluence_ask_password = True
```

--------------------------------

### Confluence Cloud publish configuration

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/autodocs/configuration.md

Example conf.py configuration for publishing to Confluence Cloud. Sets confluence_cloud to True and uses a server URL for a wiki.example.com instance.

```python
extensions = [
    'sphinxcontrib.confluencebuilder',
]
confluence_publish = True
confluence_space_key = 'MYPRJ'
confluence_server_url = 'https://wiki.example.com/'
confluence_parent_page = 'Documentation'
confluence_server_user = 'myawesomeuser@example.com'
confluence_cloud = True

```

--------------------------------

### Create minimalistic index.rst

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/tutorial.rst

Initial content for a new index.rst file in a minimalistic setup.

```rst
My documentation
================

This is a test document.
```

--------------------------------

### C# Console Application Example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/unit-tests/datasets/code-block/code-block-highlight.rst

A complete C# console application that prints 'this is an example' to the console. Uses the System, System.Collections.Generic, and System.Text namespaces.

```csharp
using System;
using System.Collections.Generic;
using System.Text;

namespace ConsoleApplication1
{
    class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("this is an example");
        }
    }
}
```

--------------------------------

### Validate artifacts with a local pip install

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/MAINTAINERS.md

Install the built wheel locally, run the extension version and a Sphinx build, then uninstall the package. This verifies the artifact works in a clean environment.

```shell
pip install dist/*.whl
cd <working-project>
python -m sphinxcontrib.confluencebuilder --version
python -m sphinx -b confluence . _build/confluence -E -a
pip uninstall sphinxcontrib-confluencebuilder
```

--------------------------------

### jira role example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/roles.rst

Use the :jira: role to create an inline Jira macro with a given issue key. The example links to TEST-123.

```rst
See :jira:`TEST-123` for more details.
```

--------------------------------

### start_tag(self, node, tag, suffix=None, empty=False, **kwargs)

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/admonitions/advanced-extensions.md

Returns content that initializes the start of a storage format element (start tag). The element of type 'tag' is initialized, and the provided node can be used to tweak the final content. Non-empty tags should be used with a respective end_tag() call.

```APIDOC
## start_tag(self, node, tag, suffix=None, empty=False, **kwargs)

### Description
Returns content that initializes the start of a storage format element (start tag). The element of type 'tag' is initialized, and the provided node can be used to tweak the final content. Non-empty tags should be used with a respective end_tag() call.

### Parameters
- **node** - The node processing the start-tag.
- **tag** - The type of tag.
- **suffix** (optional) - The suffix to add (defaults to nothing).
- **empty** (optional) - Tag will not hold child nodes (defaults to False).
- **kwargs** (optional) - Dictionary of attributes to include in the tag.

### Returns
The content.
```

--------------------------------

### Check the pip install with PyPI after release

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/MAINTAINERS.md

After the release, install the package from PyPI, run the version and a Sphinx build, then uninstall. This verifies the published package works.

```shell
cd <working-project>
pip install sphinxcontrib-confluencebuilder
python -m sphinxcontrib.confluencebuilder --version
python -m sphinx -b confluence . _build/confluence -E -a
pip uninstall sphinxcontrib-confluencebuilder
```

--------------------------------

### Windows install virtualenv (as administrator)

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/install-virtualenv.rst

Run this command in a Windows command prompt opened as administrator to install virtualenv using pip.

```doscon
> pip install virtualenv
```

--------------------------------

### Inline Math Notation

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/mermaid/math.md

Example of inline math notation using LaTeX syntax.

```none
The area of a circle is $A_\text{c} = (\pi/4) d^2$.
```

--------------------------------

### Line block markup example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/line-block.md

Example reStructuredText line block markup. Use the vertical bar (|) to start each line; continuation lines are indented. The markup is rendered with a line break after each block.

```none
| Lend us a couple of bob till Thursday.
| I'm absolutely skint.
| But I'm expecting a postal order and I can pay you back
  as soon as it comes.
| Love, Ewan.

```

--------------------------------

### start_adf_extension(self, node)

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/autodocs/advanced-extensions.md

Initializes the start of a storage format adf-extension element (ac:adf-extension). Returns content to be appended to a document.

```APIDOC
## start_adf_extension(self, node)

### Description
A helper used to return content to be appended to a document which initializes the start of a storage format adf-extension element. The `ac:adf-extension` element will be initialized. This call should be used with a respective `start_adf_extension()` call.

### Parameters
- **node** – the node processing the macro

### Returns
The content
```

--------------------------------

### Sphinx toctree directive example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/validation-sets/sphinx/index.rst

Example of a Sphinx toctree directive with maxdepth option and three document entries.

```none
.. toctree::
    :maxdepth: 1

    doca
    docb
    docc
```

--------------------------------

### Line Block Markup

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/admonitions/line-block.md

Example of a line block in reStructuredText. Each line starts with a pipe (|) and subsequent lines are indented to continue the block.

```none
| Lend us a couple of bob till Thursday.
| I'm absolutely skint.
| But I'm expecting a postal order and I can pay you back
  as soon as it comes.
| Love, Ewan.
```

--------------------------------

### Container collapse class hint example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/linkcode/guide-collapse.md

Apply the collapse class hint to a container directive to collapse its contents. This feature is supported for containers starting in version 2.1.

```rst
.. container:: collapse

    This paragraph should be collapsed.

```

--------------------------------

### Math output examples in LaTeX

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/jinja/math.md

Examples of math output in LaTeX format, including inline math, display math, an equation with an ID, and a non-wrapped equation array. These are rendered by the Confluence Builder.

```latex
The area of a circle is $A_\text{c} = (\pi/4) d^2$.
```

```latex
$$
E = mc^2
$$
```

```latex
$$
e^{i\pi} + 1 = 0

$$
```

```latex
$$
\begin{eqnarray}
   y    & = & ax^2 + bx + c \\
   f(x) & = & x^2 + 2xy + y^2
\end{eqnarray}
$$
```

--------------------------------

### start_adf_node(self, node, type_, empty=False)

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/autodocs/advanced-extensions.md

Initializes the start of a storage format adf-node element of a specific type. Returns content to be appended to a document.

```APIDOC
## start_adf_node(self, node, type_, empty=False)

### Description
A helper used to return content to be appended to a document which initializes the start of a storage format adf-node element of a specific `type`. The `ac:adf-node` element will be initialized. This method may use provided `node` to tweak the final content. This call should be used with a respective `end_adf_node()` call.

### Parameters
- **node** – the node processing the macro
- **type_** – the type of the adf-node element
- **empty** (*optional*) – whether the node is empty (defaults to False)

### Returns
The content
```

--------------------------------

### Strong emphasis markup example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/markup.md

Demonstrates the syntax for applying strong emphasis to text in reStructuredText.

```none
This is **strong emphasis** text.
```

--------------------------------

### reStructuredText note admonition example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/admonitions.md

Example markup for a reStructuredText note admonition. The admonition is translated to a Confluence informative macro (info, tip, etc.).

```none
.. note::

    This is a "note" block message.
```

--------------------------------

### Basic :confluence_status: usage

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/roles.rst

Example of creating a standard inlined status macro.

```rst
:confluence_status:`My Status`
```

--------------------------------

### Confluence Server publish configuration with cloud flag

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/admonitions/configuration.md

Example conf.py for publishing to a Confluence Server instance (https://wiki.example.com/) with confluence_cloud = True. Requires the CONFLUENCE_API_TOKEN environment variable.

```python
extensions = [
    'sphinxcontrib.confluencebuilder',
]
confluence_publish = True
confluence_space_key = 'MYPRJ'
confluence_server_url = 'https://wiki.example.com/'
confluence_parent_page = 'Documentation'
confluence_server_user = 'myawesomeuser@example.com'
confluence_cloud = True

```

```none
export CONFLUENCE_API_TOKEN=TOKEN
 (or)
set CONFLUENCE_API_TOKEN=TOKEN

```

--------------------------------

### Ruby print statement

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/unit-tests/datasets/code-block/code-block.rst

A simple Ruby example using the sourcecode directive to output text.

```ruby
puts 'this is a print statement!'
```

--------------------------------

### Build math sample with HTML builder

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/README.md

Invokes the same math project using the HTML builder for comparison with Confluence-generated documents.

```shell
tox -c tests/sample-sets/math -- -b html
```

--------------------------------

### Versionchanged directive markup

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/admonitions/versionchanged.md

Example of the versionchanged directive syntax used to document parameter changes.

```none
.. versionchanged:: 2.5
    The *spam* parameter.
```

--------------------------------

### Standard Python Code Block

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/unit-tests/datasets/code-block-params/code-block-collapse.rst

A basic Python code block example.

```python
import example
example.method1()
```

--------------------------------

### start_ri_attachment(self, node, filename)

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/autodocs/advanced-extensions.md

Initializes the start of a storage format attachment element (ri:attachment). Returns content to be appended to a document.

```APIDOC
## start_ri_attachment(self, node, filename)

### Description
A helper used to return content to be appended to a document which initializes the start of a storage format attachment element. The `ri:attachment` element will be initialized. This method may use provided `node` to tweak the final content.

### Parameters
- **node** – the node processing the attachment
- **filename** – the filename of the attachment

### Returns
The content
```

--------------------------------

### jira directive basic example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/directives.rst

Basic usage of the jira directive with a JQL query to build a Jira macro.

```rst
.. jira:: project = "TEST"
```

--------------------------------

### start_ac_link_body

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/program-output/advanced-extensions.md

Helper to generate the start tag for an ac:link-body storage format element. Should be paired with end_ac_link_body.

```APIDOC
## start_ac_link_body(self, node)

### Description
A helper used to return content to be appended to a document which initializes the start of a storage format link-body element. The `ac:link-body` element will be initialized.

### Method
start_ac_link_body

### Parameters
- **node** – the node processing the macro

### Returns
the content
```

--------------------------------

### External image with link

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/admonitions/images.md

Example of an image hosted on an external server that also functions as a link target.

```markdown
[![pip Version](https://img.shields.io/pypi/v/sphinxcontrib-confluencebuilder.svg)](https://pypi.python.org/pypi/sphinxcontrib-confluencebuilder)
```

--------------------------------

### hlist directive usage

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/hlist.md

Example markup for the hlist directive, specifying a column count of 3.

```none
.. hlist::
   :columns: 3

   * A list of
   * short items
   * that should be
   * displayed
   * horizontally
```

--------------------------------

### Rendered graphviz directive

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/validation-sets/extensions/graphviz.rst

An example of the rendered output using the graphviz directive with center alignment.

```graphviz
.. graphviz::
    :align: center

    digraph foo {
        "bar" -> "baz";
    }
```

--------------------------------

### start_ac_image

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/program-output/advanced-extensions.md

Helper to generate the start tag for an ac:image storage format element. Should be paired with end_ac_image.

```APIDOC
## start_ac_image(self, node, **kwargs)

### Description
A helper used to return content to be appended to a document which initializes the start of a storage format image element. The `ac:image` element will be initialized.

### Method
start_ac_image

### Parameters
- **node** – the node processing the image

### Returns
the content
```

--------------------------------

### Using start_tag and end_tag in a translator

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/advanced-extensions.rst

Example of using start_tag and end_tag to wrap content in a custom node visitor.

```python
def visit_custom_node(self, node):
    self.body.append(self.start_tag(node, 'p'))
    self.context.append(self.end_tag(node))

def depart_custom_node(self, node):
    self.body.append(self.context.pop())
```

--------------------------------

### start_ac_link

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/program-output/advanced-extensions.md

Helper to generate the start tag for an ac:link storage format element. Can specify an anchor and appearance.

```APIDOC
## start_ac_link(self, node, anchor=None, appearance=None)

### Description
A helper used to return content to be appended to a document which initializes the start of a storage format link element of a specific `type`. The `ac:link` element will be initialized.

### Method
start_ac_link

### Parameters
- **node** – the node processing the link
- **anchor** (*optional*) – the anchor value to use (defaults to `None`)
- **appearance** (*optional*) – card appearance to use (defaults to `None`)

### Returns
the content
```

--------------------------------

### Python code block with caption

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/validation-sets/sphinx/code.rst

A Python code block example that includes a caption.

```python
print('Explicit is better than implicit.')
```

--------------------------------

### Confluence publish configuration with publish token

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/autodocs/configuration.md

Example conf.py configuration for publishing to Confluence using a publish token. Uses the CONFLUENCE_PUBLISH_TOKEN environment variable for authentication.

```python
extensions = [
    'sphinxcontrib.confluencebuilder',
]
confluence_publish = True
confluence_space_key = 'MYPRJ'
confluence_server_url = 'https://wiki.example.com/'
confluence_parent_page = 'Documentation'

```

--------------------------------

### versionadded directive markup

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/versionadded.md

Example markup for the versionadded directive, specifying the version and a description of the added feature.

```none
.. versionadded:: 2.5
    The *spam* parameter.
```

--------------------------------

### Create Minimalistic Sphinx Files

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/cleanup/tutorial.md

Create an index.rst file and a basic conf.py configuration file for a new documentation project.

```rst
My documentation
================

This is a test document.
```

```python
extensions = []
```

--------------------------------

### Display math example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/math.md

Display math using double dollar signs: $$E = mc^2$$. This is used for math on its own line.

```latex
$$
E = mc^2
$$
```

--------------------------------

### Figure directive example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/admonitions/images.md

Example of using the figure directive to add an image with a caption.

```markdown
![Confluence Logo](assets/confluence.png)
```

--------------------------------

### Embedded and linked images

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/admonitions/images.md

Example showing multiple images, including an embedded image and an image wrapped in a link target.

```markdown
![image](assets/github.png)![image](/workspace/input/tests/validation-sets/restructuredtext/_build/markdown/doctrees/images/embeded/8e4af8e0da1da6fb685e86c19afb5322d559a8ca.png)[![image](assets/github.png)]()
```

--------------------------------

### start_tag

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/program-output/advanced-extensions.md

Helper to generate the start tag for a storage format element. Initializes a tag of the specified type and returns the content to append to the document.

```APIDOC
## start_tag(self, node, tag, suffix=None, empty=False, **kwargs)

### Description
A helper used to return content to be appended to a document which initializes the start of a storage format element (i.e. generates a start tag). The element of type `tag` will be initialized.

### Method
start_tag

### Parameters
- **node** – the node processing the start-tag
- **tag** – the type of tag
- **suffix** (*optional*) – the suffix to add (defaults to nothing)
- **empty** (*optional*) – tag will not hold child nodes (defaults to `False`)
- **\*\*kwargs** (*optional*) – dictionary of attributes to include in the tag

### Returns
the content

### Example
```python
def visit_custom_node(self, node):
    self.body.append(self.start_tag(node, 'p'))
    self.context.append(self.end_tag(node))

def depart_custom_node(self, node):
    self.body.append(self.context.pop())
```
```

--------------------------------

### start_ri_attachment(self, node, filename)

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/math/advanced-extensions.md

Initializes the start of a storage format attachment element (ri:attachment). This method may use the provided node to tweak the final content.

```APIDOC
## start_ri_attachment(self, node, filename)

### Description
A helper used to return content to be appended to a document which initializes the start of a storage format attachment element. The ri:attachment element will be initialized. This method may use provided node to tweak the final content.

### Parameters
- **node** - the node processing the attachment
- **filename** - the filename of the attachment

### Returns
the content
```

--------------------------------

### Confluence Server publish configuration without token

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/admonitions/configuration.md

Example conf.py for publishing to a Confluence Server instance (https://wiki.example.com/) without a cloud flag. Requires the CONFLUENCE_PUBLISH_TOKEN environment variable.

```python
extensions = [
    'sphinxcontrib.confluencebuilder',
]
confluence_publish = True
confluence_space_key = 'MYPRJ'
confluence_server_url = 'https://wiki.example.com/'
confluence_parent_page = 'Documentation'

```

```none
export CONFLUENCE_PUBLISH_TOKEN=TOKEN
 (or)
set CONFLUENCE_PUBLISH_TOKEN=TOKEN

```

--------------------------------

### Sphinx code-block directive markup

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/validation-sets/sphinx/code.rst

Example of the reStructuredText markup used to define a Python code block.

```none
.. code-block:: python

    def main():
        print 'Hello, world!'

    if __name__ == '__main__':
        main()
```

--------------------------------

### Basic Confluence Cloud publish configuration

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/admonitions/configuration.md

Example conf.py for publishing to Confluence Cloud (https://example.atlassian.net/) with a parent page and user. Requires an API token set via the CONFLUENCE_API_TOKEN environment variable.

```python
extensions = [
    'sphinxcontrib.confluencebuilder',
]
confluence_publish = True
confluence_space_key = 'MYPRJ'
confluence_server_url = 'https://example.atlassian.net/'
confluence_parent_page = 'Documentation'
confluence_server_user = 'myawesomeuser@example.com'

```

```none
export CONFLUENCE_API_TOKEN=TOKEN
 (or)
set CONFLUENCE_API_TOKEN=TOKEN

```

--------------------------------

### confluence_publish_token configuration example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/admonitions/configuration.md

Set the personal access token used to authenticate with Confluence. This option is intended for Confluence Data Center. Avoid storing tokens in shared repositories.

```python
confluence_publish_token = 'AbCdEfGhIjKlMnOpQrStUvWxY/z1234567890aBc'
```

--------------------------------

### Confluence output for seealso directive

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/single-confluence-refs/seealso.md

The rendered Confluence output for the seealso directive example. It displays a 'SEE ALSO' heading with the module reference and a link to the other manual.

```text
#### SEE ALSO
Module other
Documentation of the other module.

[Other Manual](https://www.example.com/manual)
Manual for another reference related to this content.
```

--------------------------------

### Numbered equation example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/math.md

Display math with an equation anchor: $$e^{i\pi} + 1 = 0$$. The anchor allows referencing the equation.

```latex
$$
e^{i\pi} + 1 = 0

$$
```

--------------------------------

### Push the tag to GitHub to start the release workflow

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/MAINTAINERS.md

Push the release tag to the remote repository to trigger the release workflow. Replace <tag> with the actual tag name.

```shell
git push origin <tag>
```

--------------------------------

### Topic directive example markup

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/topic.md

Example reStructuredText markup for the topic directive. The body is indented and interpreted as body elements.

```none
.. topic:: Topic Title

    Subsequent indented lines comprise
    the body of the topic, and are
    interpreted as body elements.
```

--------------------------------

### reStructuredText math directive

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/confluence-card/math.md

reStructuredText math directive example. Requires LaTeX and dvipng/dvisvgm unless HTML or Marketplace-installed LaTeX macros are available on the target instance.

```none
.. math::

    E = mc^2

```

--------------------------------

### Doctest block example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/doctest.md

Shows a doctest block as it appears in reStructuredText markup. The block contains an interactive Python session and its expected output.

```none
>>> print 'this is a Doctest block'
this is a Doctest block
```

--------------------------------

### start_ac_plain_text_link_body_macro(self, node)

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/advanced-extensions.rst

Initializes the start of a storage format plain-text-body element. The ac:plain-text-body element will be initialized. This method may use the provided node to tweak the final content and should be paired with end_ac_plain_text_link_body_macro().

```APIDOC
## start_ac_plain_text_link_body_macro(self, node)

### Description
Initializes the start of a storage format plain-text-body element. The ac:plain-text-body element will be initialized. This method may use the provided node to tweak the final content and should be paired with end_ac_plain_text_link_body_macro().

### Parameters
- **node** - The node processing the macro.

### Returns
The content to be appended to the document.
```

--------------------------------

### Pull-quote directive example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/pull-quote.md

Example markup for the pull-quote directive. The directive is followed by the quoted text and an optional attribution line.

```none
.. pull-quote::

    No matter where you go, there you are.

    -- Buckaroo Banzai
```

--------------------------------

### reStructuredText image directive example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/autodocs/images.md

Example markup for the reStructuredText image directive, which adds an image to a document. The image can be local, embedded via data URI, or external. This extension uses Confluence image formatting, and the example renders an image floating in the top-right of the page.

```none
.. image:: assets/sphinx.png

```

--------------------------------

### reStructuredText epigraph directive example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/admonitions/epigraph.md

Example markup for the epigraph directive, which displays a quotation with an attribution. The output is a blockquote with the text and attribution.

```none
.. epigraph::

    No matter where you go, there you are.

    -- Buckaroo Banzai

```

--------------------------------

### start_ac_link(self, node, anchor=None, appearance=None)

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/admonitions/advanced-extensions.md

Returns content that initializes the start of a storage format link element (ac:link). The provided node can be used to tweak the final content. This call should be used with a respective end_ac_link() call.

```APIDOC
## start_ac_link(self, node, anchor=None, appearance=None)

### Description
Returns content that initializes the start of a storage format link element (ac:link). The provided node can be used to tweak the final content. This call should be used with a respective end_ac_link() call.

### Parameters
- **node** - The node processing the link.
- **anchor** (optional) - The anchor value to use (defaults to None).
- **appearance** (optional) - Card appearance to use (defaults to None).

### Returns
The content.
```

--------------------------------

### confluence_latex role example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/roles.rst

Use the :confluence_latex: role to embed inline LaTeX content. The example shows a LaTeX expression inside a sentence.

```rst
This is a :confluence_latex:`$\mathfrak{t}$est`.
```

--------------------------------

### Block Quote Markup Example

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/block-quotes.md

Example of reStructuredText block quote markup, which is an indented text block without preceding literal block markup.

```none
"It is my business to know things.  That is my trade."

-- Sherlock Holmes
```

--------------------------------

### Large Python example with line numbers (linenothreshold: 3)

Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/unit-tests/datasets/code-block/code-block-linenothreshold.rst

A four-line Python code block that exceeds the line number threshold of 3, so line numbers are displayed.

```python
import anotherbigexample
anotherbigexample.method1()
anotherbigexample.method2()
anotherbigexample.method3()
```
Tokens:
Raw