123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335 |
- import sphinx_rtd_theme
- extensions = [
- 'breathe',
- 'exhale'
- ]
- breathe_projects = {
- "EasyDK": "./doxyoutput/xml"
- }
- breathe_default_project = "EasyDK"
- exhale_args = {
- "containmentFolder": "./interface",
- "rootFileName": "Interface_root.rst",
- "rootFileTitle": "Interface",
- "doxygenStripFromPath": "../../",
- "fullApiSubSectionTitle": "API Reference",
- "createTreeView": False,
- "exhaleExecutesDoxygen": True,
- "fullToctreeMaxDepth": 3,
- "unabridgedOrphanKinds": {"dir", "file", "union", "define"},
- "exhaleDoxygenStdin": """
- INPUT = ../../include
- INCLUDE_PATH = ../../include
- EXCLUDE = ../../include/easyplugin ../../include/internal
- EXTRACT_ALL = NO
- HIDE_FRIEND_COMPOUNDS = YES
- HIDE_UNDOC_MEMBERS = YES
- CLANG_ASSISTED_PARSING = YES
- CLANG_OPTIONS = -std=c++11
- SHOW_NAMESPACES = NO
- GENERATE_TREEVIEW = YES
- GRAPHICAL_HIERARCHY = YES
- INLINE_SIMPLE_STRUCTS = YES
- """
- }
- primary_domain = 'cpp'
- highlight_language = 'cpp'
- source_suffix = '.rst'
- master_doc = 'Index'
- project = u'EasyDK'
- copyright = u'2020, Cambricon'
- author = u'Cambricon'
- version = u'2.5'
- release = u'2.5.0'
- language = 'en_US'
- exclude_patterns = []
- pygments_style = 'sphinx'
- todo_include_todos = False
- html_theme = 'sphinx_rtd_theme'
- html_sidebars = {
- '**': [
- 'relations.html',
- 'searchbox.html',
- ]
- }
- htmlhelp_basename = 'EasyDK Developer Guide'
- latex_documents = [
- (master_doc, 'EasyDK.tex', 'EasyDK Developer Guide',
- 'Cambricon', 'manual'),
- ]
- man_pages = [
- (master_doc, 'EasyDevelopmentKit', 'EasyDevelopmentKit Developer Guide',
- [author], 1)
- ]
- texinfo_documents = [
- (master_doc, 'EasyDevelopmentKit', 'EasyDevelopmentKit Developer Guide',
- author, 'EasyDevelopmentKit', 'One line description of project.',
- 'Miscellaneous'),
- ]
- latex_engine = 'xelatex'
- latex_logo = "./images/logo.png"
- latex_show_urls = 'footnote'
- latex_elements = {
- 'papersize': 'a4paper',
- 'inputenc': '',
- 'utf8extra': '',
- 'preamble': '''
- \\addto\\captionsenglish{\\renewcommand{\\chaptername}{}}
- % 设置字体
- \\usepackage{xeCJK}
- \\usepackage{fontspec}
- \\setCJKmainfont{Noto Sans CJK SC}
- \\setCJKmonofont{Noto Sans CJK SC}
- \\setmainfont{Noto Sans CJK SC}
- % 段首缩进 2 格
- \\usepackage{indentfirst}
- \\setlength{\\parindent}{2em}
- \\usepackage{setspace}
- % 1.5 倍行间距
- \\renewcommand{\\baselinestretch}{1.5}
- % 表格里的行间距
- \\renewcommand{\\arraystretch}{1.5}
- % list 列表的缩进对齐
- \\usepackage{enumitem}
- \\setlist{nosep}
- % 表格类的宏包
- \\usepackage{threeparttable}
- \\usepackage{array}
- \\usepackage{booktabs}
- % fancy 页眉页脚
- \\usepackage{fancyhdr}
- \\pagestyle{fancy}
- % 在 sphinx 生成的 tex 文件里,normal 是指普通页面(每一个章节里,除了第一页外剩下的页面)
- % 页眉,L:left,R:right,E:even,O:odd
- % 奇数页面:左边是 leftmark,章号和章名称;右边是 rightmark,节号与节名称
- % 偶数页面:左边是 rightmark,节号与节名称;右边是 leftmark,章号和章名称
- % textsl 是字体,slanted shape,对于英语而言,某种斜体。但是不同于 textit 的 italic shape
- % 左页脚:版权信息
- % 右页脚:页码数
- % rulewidth:页眉和页脚附近的横线的粗细,当设置为 0pt 时,就没有该横线
- %
- \\fancypagestyle{normal} {
- \\fancyhf{}
- \\fancyhead{}
- \\fancyhead[LE,RO]{\\textsl{\\rightmark}}
- \\fancyhead[LO,RE]{\\textsl{\\leftmark}}
- \\lfoot{Copyright © 2019 Cambricon Corporation.}
- \\rfoot{\\thepage}
- \\renewcommand{\\headrulewidth}{0.4pt}
- \\renewcommand{\\footrulewidth}{0.4pt}
- }
- % 在 sphinx 生成的 tex 文件里,plain 是指每个章节的第一页等
- \\fancypagestyle{plain} {
- \\fancyhf{}
- % left head 还可以内嵌图片,图片可以是 pdf,png,jpeg 等
- % \\lhead{\\includegraphics[height=40pt]{cn_tm.pdf}}
- \\lhead{\\large\\textcolor[rgb]{0.1804,0.4588,0.7137}{Cambricon™}}
- \\lfoot{Copyright © 2019 Cambricon Corporation.}
- \\rfoot{\\thepage}
- \\renewcommand{\\headrulewidth}{0.4pt}
- \\renewcommand{\\footrulewidth}{0.4pt}
- }
- ''',
- 'printindex': r'\footnotesize\raggedright\printindex',
- 'extraclassoptions': 'openany,oneside',
- }
|