Sample Sphinx Documentation¶
This is a very rudimentary sample page for Sphinx based documentation.
In case you’re looking for a lot of fairly extensive pages, that stretch the theme in as many reasonable ways as possible, consider scrolling right to the end of this page and looking at the Demo Documentation below.
Quick Inline Markup Demo¶
Inline markup in reStructuredText is pretty powerful. You can have emphasis,
inline literals, external hyperlinks with embedded
URIs (Python web site) standalone hyperlinks
(http://www.python.org), footnote references _ and so much more. Sometimes,
you even have some |problematic| text that doesn’t do the right things but
Sphinx still builds your page.
Often, you’ll have multiple paragraphs of text in your documentation, possibly
an explanation how stuff works. Here are some explicit interpreted text roles:
a PEP reference (PEP 287); a subscript; a superscript; and
explicit roles for standard inline
You may want to know what admonitions look like.
I just wanted to interrupt your very relevant insight, to assert my importance.
Or, maybe, you want to present a code block to the user.
1 2 3 4 5 6 7 8 9
"""Just a small code example""" class Demo: def __init__(self): super().__init__() self.ready = True def how_ready_are_we(self) -> str: return "very" if self.ready else "not at all"
- Structural Elements
- Structural Elements 2
- Paragraph Level Markup
- Lists & Tables
- API documentation and generated content
- Long Sticky Nav
- Example Menu 1
- Example Menu 2
- Example Menu 3
- Example Menu 4
- Example Menu 5
- Example Menu 6
- Example Menu 7
- Example Menu 8
- Example Menu 9
- Example Menu 10
- Example Menu 11
- Example Menu 12
- Example Menu 13
- Example Menu 14
- Example Menu 15
- Example Menu 16
- Example Menu 17
- Example Menu 18
- Example Menu 19
- Example Menu 20
- Example Submenu 1
- Example Submenu 2