parent
bbb50f68ae
commit
823c146b3a
@ -0,0 +1 @@
|
||||
Fix submodule with `__init__.pyi` documented as `__init__` instead of submodule name
|
@ -0,0 +1,18 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
templates_path = ["_templates"]
|
||||
source_suffix = ".rst"
|
||||
master_doc = "index"
|
||||
project = "pyisubmoduleinit"
|
||||
copyright = "2015, readthedocs"
|
||||
author = "readthedocs"
|
||||
version = "0.1"
|
||||
release = "0.1"
|
||||
language = "en"
|
||||
exclude_patterns = ["_build"]
|
||||
pygments_style = "sphinx"
|
||||
todo_include_todos = False
|
||||
html_theme = "alabaster"
|
||||
htmlhelp_basename = "pyisubmoduleinitdoc"
|
||||
extensions = ["sphinx.ext.autodoc", "autoapi.extension"]
|
||||
autoapi_dirs = ["example"]
|
@ -0,0 +1,19 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
"""Example __init__ in submodule foo
|
||||
|
||||
Documentation generated for this file
|
||||
should be titled submodule_foo instead of __init__
|
||||
|
||||
This is a description
|
||||
"""
|
||||
|
||||
class Foo(object):
|
||||
"""
|
||||
This is a description
|
||||
"""
|
||||
|
||||
def bar(self, a: int) -> None:
|
||||
"""
|
||||
This is a description
|
||||
"""
|
||||
...
|
@ -0,0 +1,15 @@
|
||||
Welcome to pyisubmoduleinit's documentation!
|
||||
============================================
|
||||
|
||||
.. toctree::
|
||||
|
||||
autoapi/index
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
Loading…
Reference in New Issue