本文整理汇总了Python中sphinx.ext.apidoc.main方法的典型用法代码示例。如果您正苦于以下问题:Python apidoc.main方法的具体用法?Python apidoc.main怎么用?Python apidoc.main使用的例子?那么, 这里精选的方法代码示例或许可以为您提供帮助。您也可以进一步了解该方法所在类sphinx.ext.apidoc
的用法示例。
在下文中一共展示了apidoc.main方法的15个代码示例,这些例子默认根据受欢迎程度排序。您可以为喜欢或者感觉有用的代码点赞,您的评价将有助于系统推荐出更棒的Python代码示例。
示例1: run_apidoc
# 需要导入模块: from sphinx.ext import apidoc [as 别名]
# 或者: from sphinx.ext.apidoc import main [as 别名]
def run_apidoc(_):
here = os.path.dirname(__file__)
out = os.path.abspath(os.path.join(here, 'apidocs'))
src = os.path.abspath(os.path.join(here, '..', '{{ cookiecutter.project_slug }}'))
ignore_paths = []
argv = [
"-f",
"-T",
"-e",
"-M",
"-o", out,
src
] + ignore_paths
try:
# Sphinx 1.7+
from sphinx.ext import apidoc
apidoc.main(argv)
except ImportError:
# Sphinx 1.6 (and earlier)
from sphinx import apidoc
argv.insert(0, apidoc.__file__)
apidoc.main(argv)
示例2: run_apidoc
# 需要导入模块: from sphinx.ext import apidoc [as 别名]
# 或者: from sphinx.ext.apidoc import main [as 别名]
def run_apidoc(_):
ignore_paths = [
os.path.join('..', '..', 'pulse2percept', '*', 'tests')
]
argv = [
"-f",
"-M",
"-e",
"-E",
"-T",
"-o", "aaapi",
os.path.join('..', 'pulse2percept')
] + ignore_paths
try:
# Sphinx 1.7+
from sphinx.ext import apidoc
apidoc.main(argv)
except ImportError:
# Sphinx 1.6 (and earlier)
from sphinx import apidoc
argv.insert(0, apidoc.__file__)
apidoc.main(argv)
示例3: run_apidoc
# 需要导入模块: from sphinx.ext import apidoc [as 别名]
# 或者: from sphinx.ext.apidoc import main [as 别名]
def run_apidoc(_):
current_dir = os.path.abspath(os.path.dirname(__file__))
module = os.path.join(current_dir, "..", "dipper")
argv = [
"-f",
"-T",
"-e",
"-M",
"-o", current_dir,
module
]
try:
# Sphinx 1.7+
from sphinx.ext import apidoc
apidoc.main(argv)
except ImportError:
# Sphinx 1.6 (and earlier)
from sphinx import apidoc
argv.insert(0, apidoc.__file__)
apidoc.main(argv)
示例4: run_apidoc
# 需要导入模块: from sphinx.ext import apidoc [as 别名]
# 或者: from sphinx.ext.apidoc import main [as 别名]
def run_apidoc(_):
ignore_paths = []
argv = [
"-f",
"-o", "source",
".."
] + ignore_paths
try:
# Sphinx 1.7+
from sphinx.ext import apidoc
apidoc.main(argv)
except ImportError:
# Sphinx 1.6 (and earlier)
from sphinx import apidoc
argv.insert(0, apidoc.__file__)
apidoc.main(argv)
示例5: run_apidoc
# 需要导入模块: from sphinx.ext import apidoc [as 别名]
# 或者: from sphinx.ext.apidoc import main [as 别名]
def run_apidoc(_):
"""This method is required by the setup method below."""
import os
dirname = os.path.dirname(__file__)
ignore_paths = [os.path.join(dirname, '../../aaf2/model'),]
# https://github.com/sphinx-doc/sphinx/blob/master/sphinx/ext/apidoc.py
argv = [
'--force',
'--no-toc',
'--separate',
'--module-first',
'--output-dir',
os.path.join(dirname, 'api'),
os.path.join(dirname, '../../aaf2'),
] + ignore_paths
from sphinx.ext import apidoc
apidoc.main(argv)
示例6: run_apidoc
# 需要导入模块: from sphinx.ext import apidoc [as 别名]
# 或者: from sphinx.ext.apidoc import main [as 别名]
def run_apidoc(_):
for pkg in PACKAGES:
argv = ['-e',
'-o', os.path.join(PATH_HERE, 'api'),
os.path.join(PATH_HERE, PATH_ROOT, pkg),
'**/test_*',
'--force',
'--private',
'--module-first']
try:
# Sphinx 1.7+
from sphinx.ext import apidoc
apidoc.main(argv)
except ImportError:
# Sphinx 1.6 (and earlier)
from sphinx import apidoc
argv.insert(0, apidoc.__file__)
apidoc.main(argv)
示例7: run_apidoc
# 需要导入模块: from sphinx.ext import apidoc [as 别名]
# 或者: from sphinx.ext.apidoc import main [as 别名]
def run_apidoc(_):
here = os.path.dirname(__file__)
out = os.path.abspath(os.path.join(here, 'apidocs'))
src = os.path.abspath(os.path.join(here, '..', 'scriptcwl'))
ignore_paths = []
argv = [
"-f",
"-T",
"-e",
"-M",
"-o", out,
src
] + ignore_paths
try:
# Sphinx 1.7+
from sphinx.ext import apidoc
apidoc.main(argv)
except ImportError:
# Sphinx 1.6 (and earlier)
from sphinx import apidoc
argv.insert(0, apidoc.__file__)
apidoc.main(argv)
示例8: run_apidoc
# 需要导入模块: from sphinx.ext import apidoc [as 别名]
# 或者: from sphinx.ext.apidoc import main [as 别名]
def run_apidoc(_):
for pkg in PACKAGES:
argv = ['-e',
'-o', os.path.join(PATH_HERE, 'api'),
os.path.join(PATH_HERE, PATH_ROOT, pkg),
'tests/*',
'--force']
try:
# Sphinx 1.7+
from sphinx.ext import apidoc
apidoc.main(argv)
except ImportError:
# Sphinx 1.6 (and earlier)
from sphinx import apidoc
argv.insert(0, apidoc.__file__)
apidoc.main(argv)
示例9: run_apidoc
# 需要导入模块: from sphinx.ext import apidoc [as 别名]
# 或者: from sphinx.ext.apidoc import main [as 别名]
def run_apidoc(_):
sys.path.insert(0, apidoc_output_folder)
# delete api-doc files before generating them
if os.path.exists(apidoc_output_folder):
shutil.rmtree(apidoc_output_folder)
for pkg in PACKAGES:
argv = ['-e',
'-o', apidoc_output_folder,
os.path.join(PATH_ROOT, pkg),
'**/test_*',
'--force',
'--private',
'--module-first']
apidoc.main(argv)
示例10: run_apidoc
# 需要导入模块: from sphinx.ext import apidoc [as 别名]
# 或者: from sphinx.ext.apidoc import main [as 别名]
def run_apidoc(_):
import os
import sys
from sphinx.ext import apidoc
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
cur_dir = os.path.abspath(os.path.dirname(__file__))
module = '../elektronn3'
output_path = os.path.join(cur_dir, 'source')
argv = [
"-f",
"-T",
"-e",
"-M",
"-o", output_path,
module
]
apidoc.main(argv) # Requires sphinx>=1.7.1
示例11: run_apidoc
# 需要导入模块: from sphinx.ext import apidoc [as 别名]
# 或者: from sphinx.ext.apidoc import main [as 别名]
def run_apidoc(_):
ignore_paths = []
argv = [
'-f',
'-T',
'-M',
'-o', './_apidoc',
'../src/'
] + ignore_paths # yapf: disable
try:
# Sphinx 1.7+
from sphinx.ext import apidoc
apidoc.main(argv)
except ImportError:
# Sphinx 1.6 (and earlier)
from sphinx import apidoc
argv.insert(0, apidoc.__file__)
apidoc.main(argv)
示例12: run_apidoc
# 需要导入模块: from sphinx.ext import apidoc [as 别名]
# 或者: from sphinx.ext.apidoc import main [as 别名]
def run_apidoc(_):
ignore_paths = []
argv = [
"-f",
"-o", "apidoc",
"./ocs_ci"
] + ignore_paths
try:
# Sphinx 1.7+
from sphinx.ext import apidoc
apidoc.main(argv)
except ImportError:
# Sphinx 1.6 (and earlier)
from sphinx import apidoc
argv.insert(0, apidoc.__file__)
apidoc.main(argv)
示例13: run_apidoc
# 需要导入模块: from sphinx.ext import apidoc [as 别名]
# 或者: from sphinx.ext.apidoc import main [as 别名]
def run_apidoc(_):
ignore_paths = [
]
docs_path = os.path.relpath(os.path.dirname(__file__))
root_path = os.path.relpath(os.path.dirname(os.path.dirname(__file__)))
argv = [
'--force',
'--no-toc',
'--separate',
'--module-first',
'--output-dir', os.path.join(docs_path, 'packages'),
os.path.join(root_path, 'kopf'),
] + ignore_paths
try:
# Sphinx 1.7+
from sphinx.ext import apidoc
apidoc.main(argv)
except ImportError:
# Sphinx 1.6 (and earlier)
from sphinx import apidoc
argv.insert(0, apidoc.__file__)
apidoc.main(argv)
示例14: RunSphinxAPIDoc
# 需要导入模块: from sphinx.ext import apidoc [as 别名]
# 或者: from sphinx.ext.apidoc import main [as 别名]
def RunSphinxAPIDoc(app):
"""Runs sphinx-apidoc to auto-generate documentation.
Args:
app (sphinx.application.Sphinx): Sphinx application. Required by the
the Sphinx event callback API.
"""
current_directory = os.path.abspath(os.path.dirname(__file__))
module_path = os.path.join(current_directory, '..', 'plaso')
api_directory = os.path.join(current_directory, 'sources', 'api')
apidoc.main(['-o', api_directory, module_path, '--force'])
示例15: run_apidoc
# 需要导入模块: from sphinx.ext import apidoc [as 别名]
# 或者: from sphinx.ext.apidoc import main [as 别名]
def run_apidoc(_):
here = os.path.dirname(__file__)
out = os.path.abspath(os.path.join(here, '_apidoc'))
src = os.path.abspath(os.path.join(here, '..'))
ignore_paths = [
os.path.join(src, 'integration_test'),
os.path.join(src, 'setup.py'),
os.path.join(src, 'process_changelog.py'),
os.path.join(src, 'recipyGui', 'tests'),
os.path.join(src, 'recipyCommon', 'tests'),
os.path.join(src, 'recipy', 'tests'),
]
argv = [
"-f",
"-l",
"-e",
"-M",
"-o", out,
src,
] + ignore_paths
print(' '.join(argv))
try:
# Sphinx 1.7+
from sphinx.ext import apidoc
apidoc.main(argv)
except ImportError:
# Sphinx 1.6 (and earlier)
from sphinx import apidoc
argv.insert(0, apidoc.__file__)
apidoc.main(argv)