mirror of
https://github.com/readthedocs/sphinx_rtd_theme.git
synced 2025-02-25 18:55:21 -06:00
15fdfa15dc
* Fix definition lists inside api docs This is similar to #1080 (and is needed to fix citations in the demo here) Fixes #1052 * Build Assets * Build Assets 2 * New build of theme.css and theme.js * Regenerate theme.css for https://github.com/readthedocs/sphinx_rtd_theme/pull/1084 Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
149 lines
4.0 KiB
Python
149 lines
4.0 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""Test Module for sphinx_rtd_theme."""
|
|
|
|
|
|
class Foo:
|
|
|
|
"""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.
|
|
|
|
Term
|
|
It is also possible to include definitions inside docstrings.
|
|
They should be styled as a normal definition list.
|
|
|
|
:Field List:
|
|
It is also possible to include definitions inside docstrings.
|
|
They should be styled as a normal definition list.
|
|
|
|
.. [1] A footnote contains body elements, consistently indented by at
|
|
least 3 spaces.
|
|
|
|
.. [Citation] A citation contains body elements, consistently indented by at
|
|
least 3 spaces.
|
|
|
|
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 :py:meth:`capitalize`.
|
|
Here is a link to :py:meth:`__init__`.
|
|
|
|
"""
|
|
|
|
#: Doc comment for class attribute Foo.bar.
|
|
#: It can have multiple lines.
|
|
bar = 1
|
|
|
|
flox = 1.5 #: Doc comment for Foo.flox. One line only.
|
|
|
|
baz = 2
|
|
"""Docstring for class attribute Foo.baz."""
|
|
|
|
def __init__(self, qux, spam=False):
|
|
"""Start the Foo.
|
|
|
|
:param qux: The first argument to initialize class.
|
|
:type qux: string
|
|
:param spam: Spam me yes or no...
|
|
:type spam: bool
|
|
|
|
"""
|
|
#: Doc comment for instance attribute qux.
|
|
self.qux = 3
|
|
|
|
self.spam = 4
|
|
"""Docstring for instance attribute spam."""
|
|
|
|
def add(self, val1, val2):
|
|
"""Return the added values.
|
|
|
|
:param val1: First number to add.
|
|
:type val1: int
|
|
:param val2: Second number to add.
|
|
:type val2: int
|
|
:rtype: int
|
|
|
|
The parameters of this method are described in the parameter list.
|
|
"""
|
|
|
|
return val1 + val2
|
|
|
|
def capitalize(self, myvalue):
|
|
"""Return a string as uppercase.
|
|
|
|
:param myvalue: String to change
|
|
:type myvalue: string
|
|
:rtype: string
|
|
|
|
"""
|
|
|
|
return myvalue.upper()
|
|
|
|
def another_function(self, a, b, **kwargs):
|
|
"""
|
|
Here is another function.
|
|
|
|
:param a: The number of green hats you own.
|
|
:type a: int
|
|
|
|
:param b: The number of non-green hats you own.
|
|
:type b: int
|
|
|
|
:param kwargs: 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.
|
|
:type kwargs: float
|
|
|
|
: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: :math:`a + b`.
|
|
:rtype: tuple
|
|
|
|
:raises ValueError: When ``a`` is not an integer.
|
|
|
|
.. versionadded:: 1.0
|
|
This was added in 1.0
|
|
.. versionchanged:: 2.0
|
|
This was changed in 2.0
|
|
.. deprecated:: 3.0
|
|
This is deprecated since 3.0
|
|
"""
|
|
return sum(kwargs.values()) / len(kwargs), a + b
|
|
|
|
|
|
def add_numbers(a: int, b: int = 0) -> int:
|
|
"""Add two numbers together
|
|
|
|
:param a: The first number
|
|
:param b: The second number
|
|
|
|
Here is some more text.
|
|
"""
|
|
return a + b
|
|
|
|
|
|
def subtract_numbers(a: int, b: int = 0) -> int:
|
|
"""Subtract two numbers
|
|
|
|
:param a: The first number
|
|
:param b: The second number
|
|
"""
|
|
return a - b
|