parent
48ec2b341e
commit
613eff53a7
@ -0,0 +1,32 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
templates_path = ["_templates"]
|
||||
source_suffix = ".rst"
|
||||
master_doc = "index"
|
||||
project = u"pyexample"
|
||||
copyright = u"2015, readthedocs"
|
||||
author = u"readthedocs"
|
||||
version = "0.1"
|
||||
release = "0.1"
|
||||
language = None
|
||||
exclude_patterns = ["_build"]
|
||||
pygments_style = "sphinx"
|
||||
todo_include_todos = False
|
||||
html_theme = "alabaster"
|
||||
html_static_path = ["_static"]
|
||||
htmlhelp_basename = "pyexampledoc"
|
||||
extensions = ["sphinx.ext.autodoc", "autoapi.extension", "sphinx.ext.napoleon"]
|
||||
autoapi_type = "python"
|
||||
autoapi_dirs = ["example"]
|
||||
autoapi_python_class_content = "both"
|
||||
autoapi_options = [
|
||||
"members",
|
||||
"undoc-members", # this is temporary until we add docstrings across the codebase
|
||||
"show-inheritance",
|
||||
"show-module-summary",
|
||||
"special-members",
|
||||
"imported-members",
|
||||
"inherited-members",
|
||||
]
|
||||
|
||||
autodoc_typehints = "description"
|
@ -0,0 +1,7 @@
|
||||
class A:
|
||||
def test(a: int) -> bool:
|
||||
"""Test.
|
||||
Args:
|
||||
a: Argument
|
||||
"""
|
||||
return False
|
@ -0,0 +1,7 @@
|
||||
class B:
|
||||
def test(a: int) -> bool:
|
||||
"""Test.
|
||||
Args:
|
||||
a: Argument
|
||||
"""
|
||||
return False
|
@ -0,0 +1,25 @@
|
||||
.. pyexample documentation master file, created by
|
||||
sphinx-quickstart on Fri May 29 13:34:37 2015.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to pyexample's documentation!
|
||||
=====================================
|
||||
|
||||
.. toctree::
|
||||
|
||||
autoapi/index
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
Loading…
Reference in New Issue