Validate homepage has been moved. Please venture to:

https://sphinxcontrib-confluencebuilder.atlassian.net/

v1.2-code

Owned by sphinxcontrib-confluencebuilder
Jan 03, 2020

The following contains a series of code examples using Sphinx’s code markup. The first code block is an example of Python-styled code:

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

if __name__ == '__main__':
    main()

Code blocks do not have to be Python-specific, seen with this C-styled code block:

#include <stdio.h>

int main(void)
{
    printf("Hello, world!");
    return 0;
}

Code blocks can optionally display line numbers (defined by Sphinx’s code markup :linenos:):

#include <iostream>

int main()
{
    std::cout << "Hello, world!";
    return 0;
}

Presenting another code block which contains CDATA information (which should be escaped to prevent publishing issues or display issues):

<html>
<header>
    <title>my-example</title>
    <script type="text/javascript">
    /* <![CDATA[ */
    alert('Hello, world!');
    /* ]]> */
    </script>
</header>
<body>
    Hello, world!
</body>
</html>

doctest entries should display a code markup styled in Python:

>>> print "This is a doctest block."
This is a doctest block.

Documentation may included parsed literals. While parsed literals cannot take advantage of Confluence’s code macros, it is important that the content is rendered with the document-defined inline markup:

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

if __name__ == '__main__':
    main()