mirror of
https://github.com/readthedocs/sphinx-autoapi
synced 2024-11-10 01:10:27 +00:00
39 lines
974 B
Python
39 lines
974 B
Python
from .mappers import (
|
|
DotNetSphinxMapper,
|
|
PythonSphinxMapper,
|
|
GoSphinxMapper,
|
|
JavaScriptSphinxMapper,
|
|
)
|
|
|
|
DEFAULT_FILE_PATTERNS = {
|
|
"python": ["*.py", "*.pyi"],
|
|
"dotnet": ["project.json", "*.csproj", "*.vbproj"],
|
|
"go": ["*.go"],
|
|
"javascript": ["*.js"],
|
|
}
|
|
|
|
|
|
DEFAULT_IGNORE_PATTERNS = {
|
|
"dotnet": ["*toc.yml", "*index.yml"],
|
|
"python": ["*migrations*"],
|
|
"go": ["_test.go"],
|
|
}
|
|
|
|
|
|
LANGUAGE_MAPPERS = {
|
|
"python": PythonSphinxMapper,
|
|
"dotnet": DotNetSphinxMapper,
|
|
"go": GoSphinxMapper,
|
|
"javascript": JavaScriptSphinxMapper,
|
|
}
|
|
|
|
|
|
#: describes backend requirements in form
|
|
#: {'backend name': (('1st package name in pypi', '1st package import name'), ...)}
|
|
LANGUAGE_REQUIREMENTS = {
|
|
"python": (),
|
|
"javascript": (),
|
|
"go": (("sphinxcontrib-golangdomain", "sphinxcontrib.golangdomain"),),
|
|
"dotnet": (("sphinxcontrib-dotnetdomain", "sphinxcontrib.dotnetdomain"),),
|
|
} # type: Dict[str, Sequence[Tuple[str, str]]]
|