### Hello World Command Example Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/sphinx-click/index.md Demonstrates a basic 'hello-world' command with simple text output. This is useful for initial setup and testing. ```text { "field1": "value1", "field2": "value2" } ``` ```shell hello-world [OPTIONS] ``` -------------------------------- ### Install and activate on Windows with virtualenv Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/install-virtualenv.md Creates a virtual environment, activates it, installs the package, and verifies the installation on Windows. ```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 ``` -------------------------------- ### Install on Ubuntu with virtualenv Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/install-virtualenv.md Installs pip, virtualenv, and the package on Ubuntu, then activates the virtual environment and verifies the installation. ```shell $ 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 ``` -------------------------------- ### Install Sphinx Confluence Builder Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/README.md Install the extension using pip. This command installs the package for the current Python environment. ```shell pip install sphinxcontrib-confluencebuilder (or) python -m pip install sphinxcontrib-confluencebuilder ``` -------------------------------- ### Example Configured Server URL Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/guide-scope-token.md An example of a fully configured Confluence server URL using a specific Cloud identifier (GUID). ```python confluence_server_url = 'https://api.atlassian.com/ex/confluence/550e8400-e29b-41d4-a716-446655440000/' ``` -------------------------------- ### GET Request for User Posts Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/httpdomain/index.md Example of an HTTP GET request to retrieve posts by a specific user and tag. Includes request headers and expected response format. ```http GET /users/123/posts/web HTTP/1.1 Host: example.com Accept: application/json, text/javascript ``` -------------------------------- ### Sphinx Quick-Start Commands Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/tutorial.md Use these commands to initiate a new Sphinx project using the quick-start utility. This is a common starting point for new documentation projects. ```shell sphinx-quickstart (or) python -m sphinx.cmd.quickstart (or) python -m sphinx.quickstart ``` -------------------------------- ### View Storage Format Example Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/guide-math.md Example of how a macro name appears in Confluence's storage format. ```none ... ``` -------------------------------- ### Install sphinxcontrib-confluencebuilder on OS X Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/install.md Steps for installing pip using easy_install and the package on OS X, followed by verification. ```shell-session $ sudo easy_install pip $ pip install sphinxcontrib-confluencebuilder $ python -m sphinxcontrib.confluencebuilder --version sphinxcontrib.confluencebuilder ``` -------------------------------- ### Confluence Personal Space Key Configuration Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/configuration.md Example of configuring a space key for a user's personal Confluence space, which typically starts with a tilde. ```python confluence_space_key = '~123456789' ``` -------------------------------- ### reStructuredText Math Directive Example Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/confluence-code-block-theme/math.md This snippet shows the basic reStructuredText markup for the math directive. Ensure your Confluence instance has the necessary LaTeX and rendering tools installed. ```none .. math:: E = mc^2 ``` -------------------------------- ### Install on Ubuntu with virtualenv Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/sphinx-video/install-virtualenv.md Use this snippet to install the package on Ubuntu. It ensures pip and virtualenv are installed, creates a virtual environment, activates it, installs the package, and verifies the installation. ```shell 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 ``` -------------------------------- ### Multi-line Display Math Example Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/markdown-myst/math.md Shows how to render multiple lines of mathematical equations using the \begin{eqnarray} environment in LaTeX. ```text Non-wrapped math example: $$ \begin{eqnarray} y & = & ax^2 + bx + c \\ f(x) & = & x^2 + 2xy + y^2 \end{eqnarray} $$ ``` -------------------------------- ### Install on Fedora with virtualenv Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/sample-sets/sphinx-video/install-virtualenv.md Use this snippet to install the package on Fedora. It ensures pip and virtualenv are installed, creates a virtual environment, activates it, installs the package, and verifies the installation. ```shell 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 ``` -------------------------------- ### Invoke Example Function Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/tests/unit-tests/datasets/code-block/code-block.rst Demonstrates how to import and invoke a function from a custom module. ```python import myexample myexample.invoke() ``` -------------------------------- ### Install sphinxcontrib-confluencebuilder on Ubuntu Source: https://github.com/sphinx-contrib/confluencebuilder/blob/main/doc/install.md Steps for installing pip and the package on Ubuntu, followed by verification. ```shell-session $ sudo apt-get update $ sudo apt-get install python-pip $ pip install sphinxcontrib-confluencebuilder $ python -m sphinxcontrib.confluencebuilder --version sphinxcontrib.confluencebuilder ```