domdf_sphinx_theme¶
Customised ‘sphinx_rtd_theme’ used by my Python projects.
Based on sphinx_rtd_theme by ReadTheDocs.
Docs |
|
---|---|
Tests |
|
PyPI |
|
Activity |
|
QA |
|
Other |
Changes include:
Smooth scrolling between sections.
Wider body by default.
Extra spacing in lists.
Some JavaScript trickery to fix the ReadTheDocs versions menu.
Installation¶
python3 -m pip install domdf_sphinx_theme --user
python3 -m pip install git+https://github.com/domdfcoding/domdf_sphinx_theme@master --user
Then in your conf.py
file:
html_theme = "domdf_sphinx_theme"
Configuration¶
Theme options¶
The following options can be defined in your project’s conf.py
file, using
the html_theme_options
configuration option.
For example:
html_theme_options = {
'canonical_url': '',
'logo_only': False,
'display_version': True,
'prev_next_buttons_location': 'bottom',
'style_external_links': False,
'vcs_pageview_mode': '',
'style_nav_header_background': 'white',
# Toc options
'collapse_navigation': True,
'sticky_navigation': True,
'navigation_depth': 4,
'includehidden': True,
'titles_only': False
}
Table of contents options¶
The following options change how toctree
directives generate
documentation navigation.
- Type:
boolean
- Default:
True
With this enabled, navigation entries are not expandable – the
[+]
icons next to each entry are removed.
- Type:
boolean
- Default:
True
Scroll the navigation with the main page content as you scroll the page.
- Type:
integer
- Default:
4
The maximum depth of the table of contents tree. Set this to
-1
to allow unlimited depth.
- Type:
boolean
- Default:
True
Specifies if the navigation includes hidden table(s) of contents – that is, any
toctree
directive that is marked with the:hidden:
option.
- titles_only¶
- Type:
boolean
- Default:
False
When enabled, page subheadings are not included in the navigation.
Note
Setting collapse_navigation
to False
and using a high value
for navigation_depth
on projects with many files and a deep file
structure can cause long compilation times and can result in HTML files that
are significantly larger in file size.
Miscellaneous options¶
- canonical_url¶
- Type:
URL
This will specify a canonical URL meta link element to tell search engines which URL should be ranked as the primary URL for your documentation. This is important if you have multiple URLs that your documentation is available through. The URL points to the root path of the documentation and requires a trailing slash.
- display_version¶
- Type:
boolean
- Default:
True
If
True
, the version number is shown at the top of the sidebar.
- logo_only¶
- Type:
boolean
- Default:
False
Only display the logo image, do not display the project name at the top of the sidebar
- prev_next_buttons_location¶
- Type:
string
- Default:
bottom
Location to display Next and Previous buttons. This can be either
bottom
,top
,both
, orNone
.
- style_external_links¶
- Type:
boolean
- Default:
False
Add an icon next to external links.
- vcs_pageview_mode¶
- Type:
string
- Default:
blob
orview
Changes how to view files when using
display_github
,display_gitlab
, etc. When using GitHub or GitLab this can be:blob
(default),edit
, orraw
. On Bitbucket, this can be either:view
(default) oredit
.
- Type:
string
- Default:
#2980B9
Changes the background of the search area in the navigation bar. The value can be anything valid in a CSS
background
property.
File-wide metadata¶
The following options can be used as file-wide metadata:
- github_url¶
Force the Edit on GitHub button to use the configured URL.
- bitbucket_url¶
Force the Edit on Bitbucket button to use the configured URL.
- gitlab_url¶
Force the Edit on GitLab button to use the configured URL.
Other configuration¶
Adding a logo¶
Using the Sphinx standard option html_logo
,
you can set an image file to be used as a logo at the top of the sidebar. The
theme option logo_only
also allows for only the logo to be shown
at the top of the sidebar.
Adding custom CSS or Javascript¶
Adding custom CSS or Javascript can help you alter the look and feel of this theme without forking the theme for local use.
In order to add custom CSS or Javascript without disrupting the existing theme files, you can add files to be included in your documentation output.
How the table of contents displays¶
Currently the left menu will build based upon any toctree
directives defined
in your source files. It outputs 4 levels of depth by default, to allow for
quick navigation through topics. If no TOC trees are defined, Sphinx’s default
behavior is to use the page headings instead.
It’s important to note that if you don’t follow the same styling for your reST headings across your documents, the TOC tree will build incorrectly, and the resulting menu might not show the correct depth when it renders.
Also note that by default the table of contents is set with
includehidden=True
. This allows you to set a hidden TOC in your index file
with the :hidden: property that will allow you
to build a TOC without it rendering in your index.
By default, the navigation will “stick” to the screen as you scroll. However if
your TOC is not tall enough, it will revert to static positioning. To disable the
sticky navigation altogether, change the sticky_navigation
theme option.
License¶
domdf_sphinx_theme
is licensed under the MIT License
A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.
Permissions | Conditions | Limitations |
---|---|---|
|
|
Copyright (c) 2020 Dominic Davis-Foster
Based on https://github.com/readthedocs/sphinx_rtd_theme
Copyright (c) 2013-2018 Dave Snider, Read the Docs, Inc. & contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
OR OTHER DEALINGS IN THE SOFTWARE.
Structural Elements¶
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec lorem neque, interdum in ipsum nec, finibus dictum velit. Ut eu efficitur arcu, id aliquam erat. In sit amet diam gravida, imperdiet tellus eu, gravida nisl. Praesent aliquet odio eget libero elementum, quis rhoncus tellus tincidunt. Suspendisse quis volutpat ipsum. Sed lobortis scelerisque tristique. Aenean condimentum risus tellus, quis accumsan ipsum laoreet ut. Integer porttitor maximus suscipit. Mauris in posuere sapien. Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.
Etiam turpis ante, luctus sed velit tristique, finibus volutpat dui. Nam sagittis vel ante nec malesuada. Praesent dignissim mi nec ornare elementum. Nunc eu augue vel sem dignissim cursus sed et nulla. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Pellentesque dictum dui sem, non placerat tortor rhoncus in. Sed placerat nulla at rhoncus iaculis.
Document Section¶
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed condimentum nulla vel neque venenatis, nec placerat lorem placerat. Cras purus eros, gravida vitae tincidunt id, vehicula nec nulla. Fusce aliquet auctor cursus. Phasellus ex neque, vestibulum non est vitae, viverra fringilla tortor. Donec vestibulum convallis justo, a faucibus lorem vulputate vel. Aliquam cursus odio eu felis sodales aliquet. Aliquam erat volutpat. Maecenas eget dictum mauris. Suspendisse arcu eros, condimentum eget risus sed, luctus efficitur arcu. Cras ut dictum mi. Nulla congue interdum lorem, semper semper enim commodo nec.
Document Subsection¶
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam efficitur in eros et blandit. Nunc maximus, nisl at auctor vestibulum, justo ex sollicitudin ligula, id faucibus urna orci tristique nisl. Duis auctor rutrum orci, in ornare lacus condimentum quis. Quisque arcu velit, facilisis quis interdum ac, hendrerit auctor mauris. Curabitur urna nibh, porttitor at ante sit amet, vestibulum interdum dolor. Duis dictum elit orci, tincidunt imperdiet sem pellentesque et. In vehicula pellentesque varius. Phasellus a turpis sollicitudin, bibendum massa et, imperdiet neque. Integer quis sapien in magna rutrum bibendum. Integer cursus ex sed magna vehicula finibus. Proin tempus orci quis dolor tempus, nec condimentum odio vestibulum. Etiam efficitur sollicitudin libero, tincidunt volutpat ligula interdum sed.
Document Subsubsection¶
Donec non rutrum lorem. Aenean sagittis metus at pharetra fringilla. Nunc sapien dolor, cursus sed nisi at, pretium tristique lectus. Sed pellentesque leo lectus, et convallis ipsum euismod a. Integer at leo vitae felis pretium aliquam fringilla quis odio. Sed pharetra enim accumsan feugiat pretium. Maecenas at pharetra tortor. Morbi semper eget mi vel finibus. Cras rutrum nulla eros, id feugiat arcu pellentesque ut. Sed finibus tortor ac nisi ultrices viverra. Duis feugiat malesuada sapien, at commodo ante porttitor ac. Curabitur posuere mauris mi, vel ornare orci scelerisque sit amet. Suspendisse nec fringilla dui.
Document Paragraph¶
Pellentesque nec est in odio ultrices elementum. Vestibulum et hendrerit sapien, quis vulputate turpis. Suspendisse potenti. Curabitur tristique sit amet lectus non viverra. Phasellus rutrum dapibus turpis sed imperdiet. Mauris maximus viverra ante. Donec eu egestas mauris. Morbi vulputate tincidunt euismod. Integer vel porttitor neque. Donec at lacus suscipit, lacinia lectus vel, sagittis lectus.
Structural Elements 2¶
Etiam turpis ante, luctus sed velit tristique, finibus volutpat dui. Nam sagittis vel ante nec malesuada. Praesent dignissim mi nec ornare elementum. Nunc eu augue vel sem dignissim cursus sed et nulla. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Pellentesque dictum dui sem, non placerat tortor rhoncus in. Sed placerat nulla at rhoncus iaculis.
Document Section¶
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed condimentum nulla vel neque venenatis, nec placerat lorem placerat. Cras purus eros, gravida vitae tincidunt id, vehicula nec nulla. Fusce aliquet auctor cursus. Phasellus ex neque, vestibulum non est vitae, viverra fringilla tortor. Donec vestibulum convallis justo, a faucibus lorem vulputate vel. Aliquam cursus odio eu felis sodales aliquet. Aliquam erat volutpat. Maecenas eget dictum mauris. Suspendisse arcu eros, condimentum eget risus sed, luctus efficitur arcu. Cras ut dictum mi. Nulla congue interdum lorem, semper semper enim commodo nec.
Document Subsection¶

This is a caption for a figure. Text should wrap around the caption.¶
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam efficitur in eros et blandit. Nunc maximus, nisl at auctor vestibulum, justo ex sollicitudin ligula, id faucibus urna orci tristique nisl. Duis auctor rutrum orci, in ornare lacus condimentum quis. Quisque arcu velit, facilisis quis interdum ac, hendrerit auctor mauris. Curabitur urna nibh, porttitor at ante sit amet, vestibulum interdum dolor. Duis dictum elit orci, tincidunt imperdiet sem pellentesque et. In vehicula pellentesque varius. Phasellus a turpis sollicitudin, bibendum massa et, imperdiet neque. Integer quis sapien in magna rutrum bibendum. Integer cursus ex sed magna vehicula finibus. Proin tempus orci quis dolor tempus, nec condimentum odio vestibulum. Etiam efficitur sollicitudin libero, tincidunt volutpat ligula interdum sed. Praesent congue sagittis nisl et suscipit. Vivamus sagittis risus et egestas commodo.Cras venenatis arcu in pharetra interdum. Donec quis metus porttitor tellus cursus lobortis. Quisque et orci magna. Fusce rhoncus mi mi, at vehicula massa rhoncus quis. Mauris augue leo, pretium eget molestie vitae, efficitur nec nulla. In hac habitasse platea dictumst. Sed sit amet imperdiet purus.
Paragraph Level Markup¶
Inline Markup¶
Paragraphs contain text and may contain inline markup: emphasis, strong emphasis, inline literals
,
standalone hyperlinks (http://www.python.org), external hyperlinks (Python [5]), internal cross-references (example),
external hyperlinks with embedded URIs (Python web site), footnote references
(manually numbered [1], anonymous auto-numbered [3], labeled auto-numbered [2], or symbolic [*]),
citation references ([12]), substitution references (), and inline hyperlink targets
(see Targets below for a reference back to here). Character-level inline markup is also possible
(although exceedingly ugly!) in re
Structured
Text. Problems are indicated by |problematic|
text (generated by processing errors; this one is intentional).
Also with sphinx.ext.autodoc
, which I use in the demo, I can link to test_py_module.test.Foo
.
It will link you right my code documentation for it.
Here are some explicit interpreted text roles:
a PEP reference (PEP 287); an RFC reference (RFC 2822); a subscript; a superscript;
and explicit roles for standard inline markup
.
GUI labels are a useful way to indicate that Some action is to be taken by the user.
The GUI label should not run over line-height
so as not to interfere with text from adjacent lines.
Key-bindings indicate that the read is to press a button on the keyboard or mouse,
for example MMB and Shift-MMB. Another useful markup to indicate a user action
is to use menuselection
this can be used to show short and long menus in software.
For example, and menuselection
can be seen here that breaks is too long to fit on this line.
.
Let’s test wrapping and whitespace significance in inline literals:
This is an example of --inline-literal --text, --including some--
strangely--hyphenated-words. Adjust-the-width-of-your-browser-window
to see how the text is wrapped. -- ---- -------- Now note the
spacing between the words of this sentence (words
should be grouped in pairs).
If the --pep-references
option was supplied, there should be a live link to PEP 258 here.
Math¶
This is a test. Here is an equation: \(X_{0:5} = (X_0, X_1, X_2, X_3, X_4)\). Here is another:
You can add a link to equations like the one above (1) by using :eq:
.
Meta¶
Blocks¶
Literal Blocks¶
Literal blocks are indicated with a double-colon (“::”) at the end of
the preceding paragraph (over there -->
). They can be indented:
if literal_block:
text = 'is left as-is'
spaces_and_linebreaks = 'are preserved'
markup_processing = None
Or they can be quoted without indentation:
>> Great idea!
>
> Why didn't I think of that?
Line Blocks¶
Take it away, Eric the Orchestra Leader!
A one, two, a one two three fourHalf a bee, philosophically,must, ipso facto, half not be.But half the bee has got to be,vis a vis its entity. D’you see?But can a bee be said to beor not to be an entire bee,when half the bee is not a bee,due to some ancient injury?Singing…
Block Quotes¶
Block quotes consist of indented body elements:
My theory by A. Elk. Brackets Miss, brackets. This theory goes as follows and begins now. All brontosauruses are thin at one end, much much thicker in the middle and then thin again at the far end. That is my theory, it is mine, and belongs to me and I own it, and what it is too.
—Anne Elk (Miss)
Doctest Blocks¶
>>> print 'Python-specific usage examples; begun with ">>>"'
Python-specific usage examples; begun with ">>>"
>>> print '(cut and pasted from interactive Python sessions)'
(cut and pasted from interactive Python sessions)
Code Blocks¶
# parsed-literal test curl -O http://someurl/release-23.0.0.tar-gz
{
"windows": [
{
"panes": [
{
"shell_command": [
"echo 'did you know'",
"echo 'you can inline'"
]
},
{
"shell_command": "echo 'single commands'"
},
"echo 'for panes'"
],
"window_name": "long form"
}
],
"session_name": "shorthands"
}
Emphasized lines with line numbers¶
1 2 3 4 5 | def some_function(): interesting = False print 'This line is highlighted.' print 'This one is not...' print '...but this one is.' |
References¶
Footnotes¶
Citations¶
This is the citation I made, let’s make this extremely long so that we can tell that it doesn’t follow the normal responsive table stuff.
This citation has some code blocks
in it, maybe some bold and
italics too. Heck, lets put a link to a meta citation [13] too.
This citation will have two backlinks.
Here’s a reference to the above, [12], and a [nonexistent] citation.
Glossary¶
This is a glossary with definition terms for thing like Writing:
Targets¶
This paragraph is pointed to by the explicit “example” target. A reference can be found under Inline Markup, above. Inline hyperlink targets are also possible.
Section headers are implicit targets, referred to by name. See Targets, which is a subsection of `Body Elements`_.
Explicit external targets are interpolated into references such as “Python [5]”.
Targets may be indirect and anonymous. Thus this phrase may also refer to the Targets section.
Here’s a `hyperlink reference without a target`_, which generates an error.
Directives¶
Contents¶
These are just a sample of the many reStructuredText Directives. For others, please see: http://docutils.sourceforge.net/docs/ref/rst/directives.html.
Centered text¶
You can create a statement with centered text with .. centered::
This is centered text!
Images & Figures¶
Images¶
An image directive (also clickable – a hyperlink reference):

Figures¶

A figure is an image with a caption and/or a legend:¶
re |
Revised, revisited, based on ‘re’ module. |
Structured |
Structure-enhanced text, structuredtext. |
Text |
Well it is, isn’t it? |
This paragraph is also part of the legend.
A figure directive with center alignment

This caption should be centered.¶
Admonitions¶
Attention
Directives at large.
Caution
Don’t take any wooden nickels.
Danger
Mad scientist at work!
Error
Does not compute.
Hint
It’s bigger than a bread box.
Important
Wash behind your ears.
Clean up your room.
Including the closet.
The bathroom too.
Take the trash out of the bathroom.
Clean the sink.
Call your mother.
Back up your data.
Note
This is a note. Equations within a note: \(G_{\mu\nu} = 8 \pi G (T_{\mu\nu} + \rho_\Lambda g_{\mu\nu})\).
Tip
15% if the service is good.
Example |
---|
Thing1 |
Thing2 |
Thing3 |
Warning
Strong prose may provoke extreme mental exertion. Reader discretion is strongly advised.
And, by the way…
You can make up your own admonition too.
Target Footnotes¶
Replacement Text¶
I recommend you try Python, the best language around [5].
Compound Paragraph¶
This paragraph contains a literal block:
Connecting... OK
Transmitting data... OK
Disconnecting... OK
and thus consists of a simple paragraph, a literal block, and another simple paragraph. Nonetheless it is semantically one paragraph.
This construct is called a compound paragraph and can be produced with the “compound” directive.
Download Links¶
Lists & Tables¶
Lists¶
Enumerated Lists¶
Arabic numerals.
lower alpha)
(lower roman)
upper alpha.
upper roman)
Lists that don’t start at 1:
Three
Four
C
D
iii
iv
List items may also be auto-enumerated.
Definition Lists¶
- Term
Definition
- Termclassifier
Definition paragraph 1.
Definition paragraph 2.
- Term
Definition
Option Lists¶
For listing command-line options:
- -a
command-line option “a”
- -b file
options can have arguments and long descriptions
- --long
options can be long also
- --input=file
long options can also have arguments
- --very-long-option
The description can also start on the next line.
The description may contain multiple body elements, regardless of where it starts.
- -x, -y, -z
Multiple options are an “option group”.
- -v, --verbose
Commonly-seen: short & long options.
- -1 file, --one=file, --two file
Multiple options with arguments.
- /V
DOS/VMS-style options too
There must be at least two spaces between the option and the description.
Field list¶
- Author:
David Goodger
- Address:
123 Example Street Example, EX Canada A1B 2C3
- Contact:
- Authors:
Me; Myself; I
- organization:
humankind
- date:
$Date: 2012-01-03 19:23:53 +0000 (Tue, 03 Jan 2012) $
- status:
This is a “work in progress”
- revision:
$Revision: 7302 $
- version:
1
- copyright:
This document has been placed in the public domain. You may do with it as you wish. You may copy, modify, redistribute, reattribute, sell, buy, rent, lease, destroy, or improve it, quote it at length, excerpt, incorporate, collate, fold, staple, or mutilate it, or do anything else to it that your or anyone else’s heart desires.
- field name:
This is a generic bibliographic field.
- field name 2:
Generic bibliographic fields may contain multiple body elements.
Like this.
- Dedication:
For Docutils users & co-developers.
- abstract:
This document is a demonstration of the reStructuredText markup language, containing examples of all basic reStructuredText constructs and many advanced constructs.
Bullet Lists¶
A bullet list
Nested bullet list.
Nested item 2.
Item 2.
Paragraph 2 of item 2.
Nested bullet list.
Nested item 2.
Third level.
Item 2.
Nested item 3.
inline literall
inline literall
inline literall
Second list level¶
here is a list in a second-level section.
-
here is an inner bullet
oh
one more
with an inline literally
. yahooheh heh. child. try to beat this embed:
1 2 3 4 5 6 7 8 9 10
""" Test Module for sphinx_rtd_theme. """ class Foo: """ Docstring for class Foo. This text tests for the formatting of docstrings generated from output
and another. yahoo
hi
and hehe
But deeper down the rabbit hole¶
Hlists¶
|
|
Hlist with images
|
|
Numbered List¶
One,
Two.
Three with long text. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed feugiat sagittis neque quis eleifend. Duis rutrum lectus sit amet mattis suscipit.
Using bullets and letters. (A)
Using bullets and letters. (B)
Using bullets and letters. (C)
Tables¶
Grid Tables¶
Here’s a grid table followed by a simple table:
Header row, column 1 (header rows optional) |
Header 2 |
Header 3 |
Header 4 |
---|---|---|---|
body row 1, column 1 |
column 2 |
column 3 |
column 4 |
body row 2 |
Cells may span columns. |
||
body row 3 |
Cells may span rows. |
|
|
body row 4 |
|||
body row 5 |
Cells may also be
empty: |
Inputs |
Output |
|
---|---|---|
A |
B |
A or B |
False |
False |
False |
True |
False |
True |
False |
True |
True |
True |
True |
True |
Giant Tables¶
Header 1 |
Header 2 |
Header 3 |
Header 1 |
Header 2 |
Header 3 |
Header 1 |
Header 2 |
Header 3 |
Header 1 |
Header 2 |
Header 3 |
---|---|---|---|---|---|---|---|---|---|---|---|
body row 1 |
column 2 |
column 3 |
body row 1 |
column 2 |
column 3 |
body row 1 |
column 2 |
column 3 |
body row 1 |
column 2 |
column 3 |
body row 1 |
column 2 |
column 3 |
body row 1 |
column 2 |
column 3 |
body row 1 |
column 2 |
column 3 |
body row 1 |
column 2 |
column 3 |
body row 1 |
column 2 |
column 3 |
body row 1 |
column 2 |
column 3 |
body row 1 |
column 2 |
column 3 |
body row 1 |
column 2 |
column 3 |
body row 1 |
column 2 |
column 3 |
body row 1 |
column 2 |
column 3 |
body row 1 |
column 2 |
column 3 |
body row 1 |
column 2 |
column 3 |
List Tables¶
List table |
Header 1 |
Header 2 |
Header 3 long. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam sit amet mauris arcu. |
---|---|---|---|
Stub Row 1 |
Row 1 |
Column 2 |
Column 3 long. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam sit amet mauris arcu. |
Stub Row 2 |
Row 2 |
Column 2 |
Column 3 long. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam sit amet mauris arcu. |
Stub Row 3 |
Row 3 |
Column 2 |
Column 3 long. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam sit amet mauris arcu. |
![]() This is a short caption for a figure.¶ |
![]() This is a long caption for a figure. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec porttitor dolor in odio posuere, vitae ornare libero mattis. In lobortis justo vestibulum nibh aliquet, non.¶ |
API documentation and generated content¶
test_py_module
¶
Test Module for sphinx_rtd_theme.
Classes:
|
Docstring for class Foo. |
- class Foo(qux, spam=False)[source]¶
Bases:
object
Docstring for class Foo.
This text tests for the formatting of docstrings generated from output
sphinx.ext.autodoc
. Which contain reST, but sphinx nests it in the<dl>
, and<dt>
tags. Also,<tt>
is used for class, method names and etc, but those will always have the.descname
or.descclassname
class.Normal
<tt>
(like the <tt> I just wrote here) needs to be shown with the same style as anything else with``this type of markup``
.It’s common for programmers to give a code example inside of their docstring:
from test_py_module import Foo myclass = Foo() myclass.dothismethod('with this argument') myclass.flush() print(myclass)
Here is a link to
capitalize()
. Here is a link to__init__()
.Methods:
add
(val1, val2)Return the added values.
another_function
(a, b, **kwargs)Here is another function.
capitalize
(myvalue)Return a string as uppercase.
Attributes:
Doc comment for class attribute Foo.bar.
Docstring for class attribute Foo.baz.
Doc comment for Foo.flox.
Doc comment for instance attribute qux.
Docstring for instance attribute spam.
- another_function(a, b, **kwargs)[source]¶
Here is another function.
- Parameters:
a (int) – The number of green hats you own.
b (int) – The number of non-green hats you own.
kwargs (float) – Additional keyword arguments. Each keyword parameter should specify the name of your favorite cuisine. The values should be floats, specifying the mean price of your favorite dish in that cooking style.
- Returns:
A 2-tuple. The first element is the mean price of all dishes across cuisines. The second element is the total number of hats you own: \(a + b\).
- Return type:
- Raises:
ValueError – When
a
is not an integer.
New in version 1.0: This was added in 1.0
Changed in version 2.0: This was changed in 2.0
Deprecated since version 3.0: This is deprecated since 3.0
- capitalize(myvalue)[source]¶
Return a string as uppercase.
- Parameters:
myvalue (string) – String to change
- Return type:
string
- qux¶
Doc comment for instance attribute qux.
- spam¶
Docstring for instance attribute spam.
C++ API¶
-
type MyType¶
Some type
-
float Sphinx::version¶
The description of Sphinx::version.
-
int version¶
The description of version.
-
typedef std::vector<int> List¶
The description of List type.
JavaScript API¶
Link to
ModTopLevel()
- class module_a.submodule.ModTopLevel()¶
Link to
mod_child_1()
Link to
ModTopLevel.mod_child_1()
- ModTopLevel.mod_child_1()¶
Link to
mod_child_2()
- ModTopLevel.mod_child_2()¶
Link to
ModTopLevel()
- class module_b.submodule.ModNested()¶
- ModNested.nested_child_1()¶
Link to
nested_child_2()
- ModNested.nested_child_2()¶
Link to
nested_child_1()
Generated Index¶
Part of the sphinx build process in generate and index file: Index.
Optional parameter args¶
At this point optional parameters cannot be generated from code. However, some projects will manually do it, like so:
This example comes from django-payments module docs.
- class payments.dotpay.DotpayProvider(seller_id, pin[, channel=0[, lock=False], lang='pl'])¶
This backend implements payments using a popular Polish gateway, Dotpay.pl.
Due to API limitations there is no support for transferring purchased items.
- Parameters:
seller_id – Seller ID assigned by Dotpay
pin – PIN assigned by Dotpay
channel – Default payment channel (consult reference guide)
lang – UI language
lock – Whether to disable channels other than the default selected above
Data¶
- Data_item_1¶
- Data_item_2¶
- Data_item_3¶
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce congue elit eu hendrerit mattis.
Some data link Data_item_1
.
Downloading source code¶
The domdf_sphinx_theme
source code is available on GitHub,
and can be accessed from the following URL: https://github.com/domdfcoding/domdf_sphinx_theme
If you have git
installed, you can clone the repository with the following command:
git clone https://github.com/domdfcoding/domdf_sphinx_theme
Cloning into 'domdf_sphinx_theme'...
remote: Enumerating objects: 47, done.
remote: Counting objects: 100% (47/47), done.
remote: Compressing objects: 100% (41/41), done.
remote: Total 173 (delta 16), reused 17 (delta 6), pack-reused 126
Receiving objects: 100% (173/173), 126.56 KiB | 678.00 KiB/s, done.
Resolving deltas: 100% (66/66), done.

Downloading a ‘zip’ file of the source code¶
Building from source¶
The recommended way to build domdf_sphinx_theme
is to use tox:
tox -e build
The source and wheel distributions will be in the directory dist
.
If you wish, you may also use pep517.build or another PEP 517-compatible build tool.
View the Function Index or browse the Source Code.