|
1 | | -# -*- coding: utf-8 -*- |
2 | | -# |
3 | 1 | # Configuration file for the Sphinx documentation builder. |
4 | 2 | # |
5 | | -# This file does only contain a selection of the most common options. For a |
6 | | -# full list see the documentation: |
7 | | -# http://www.sphinx-doc.org/en/master/config |
| 3 | +# This file only contains a selection of the most common options. For a full |
| 4 | +# list see the documentation: |
| 5 | +# https://www.sphinx-doc.org/en/master/usage/configuration.html |
8 | 6 |
|
9 | 7 | # -- Path setup -------------------------------------------------------------- |
10 | 8 |
|
11 | 9 | # If extensions (or modules to document with autodoc) are in another directory, |
12 | 10 | # add these directories to sys.path here. If the directory is relative to the |
13 | 11 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
14 | 12 | # |
15 | | -import os |
16 | | -import sys |
17 | | -import annofabapi |
18 | | - |
19 | | -sys.path.insert(0, os.path.abspath("../")) |
| 13 | +# import os |
| 14 | +# import sys |
| 15 | +# sys.path.insert(0, os.path.abspath('.')) |
20 | 16 |
|
21 | 17 |
|
22 | 18 | # -- Project information ----------------------------------------------------- |
|
25 | 21 | copyright = "2019, yuji38kwmt" |
26 | 22 | author = "yuji38kwmt" |
27 | 23 |
|
28 | | -# The short X.Y version. |
29 | | -version = annofabapi.__version__ |
30 | | -# The full version, including alpha/beta/rc tags. |
31 | | -release = annofabapi.__version__ |
32 | 24 |
|
33 | 25 | # -- General configuration --------------------------------------------------- |
34 | 26 |
|
35 | | -# If your documentation needs a minimal Sphinx version, state it here. |
36 | | -# |
37 | | -# needs_sphinx = '1.0' |
38 | | - |
39 | 27 | # Add any Sphinx extension module names here, as strings. They can be |
40 | 28 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
41 | 29 | # ones. |
|
44 | 32 | # Add any paths that contain templates here, relative to this directory. |
45 | 33 | templates_path = ["_templates"] |
46 | 34 |
|
47 | | -# The suffix(es) of source filenames. |
48 | | -# You can specify multiple suffix as a list of string: |
49 | | -# |
50 | | -# source_suffix = ['.rst', '.md'] |
51 | | -source_suffix = ".rst" |
52 | | - |
53 | | -# The master toctree document. |
54 | | -master_doc = "index" |
55 | | - |
56 | | -# The language for content autogenerated by Sphinx. Refer to documentation |
57 | | -# for a list of supported languages. |
58 | | -# |
59 | | -# This is also used if you do content translation via gettext catalogs. |
60 | | -# Usually you set "language" from the command line for these cases. |
61 | | -language = None |
62 | | - |
63 | 35 | # List of patterns, relative to source directory, that match files and |
64 | 36 | # directories to ignore when looking for source files. |
65 | 37 | # This pattern also affects html_static_path and html_extra_path. |
66 | 38 | exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
67 | 39 |
|
68 | | -# The name of the Pygments (syntax highlighting) style to use. |
69 | | -pygments_style = None |
70 | | - |
71 | 40 |
|
72 | 41 | # -- Options for HTML output ------------------------------------------------- |
73 | 42 |
|
|
76 | 45 | # |
77 | 46 | html_theme = "pydata_sphinx_theme" |
78 | 47 |
|
79 | | -# Theme options are theme-specific and customize the look and feel of a theme |
80 | | -# further. For a list of options available for each theme, see the |
81 | | -# documentation. |
82 | | -# |
83 | | -html_theme_options = { |
84 | | - "github_url": "https://github.com/kurusugawa-computer/annofab-api-python-client", |
85 | | -} |
86 | | - |
87 | 48 | # Add any paths that contain custom static files (such as style sheets) here, |
88 | 49 | # relative to this directory. They are copied after the builtin static files, |
89 | 50 | # so a file named "default.css" will overwrite the builtin "default.css". |
90 | | -# html_static_path = ['_static'] |
91 | | - |
92 | | -# Custom sidebar templates, must be a dictionary that maps document names |
93 | | -# to template names. |
94 | | -# |
95 | | -# The default sidebars (for documents that don't match any pattern) are |
96 | | -# defined by theme itself. Builtin themes are using these templates by |
97 | | -# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', |
98 | | -# 'searchbox.html']``. |
99 | | -# |
100 | | -html_sidebars = {"**": ["localtoc.html", "relations.html", "links.html", "searchbox.html"]} |
101 | | - |
102 | | -html_copy_source = True |
103 | | - |
104 | | -html_show_sourcelink = True |
105 | | - |
106 | | -html_logo = "img/logo_landscape.png" |
| 51 | +html_static_path = ["_static"] |
107 | 52 |
|
108 | | -# html_favicon = "img/favicon.ico" |
109 | | - |
110 | | -# -- Options for HTMLHelp output --------------------------------------------- |
111 | | - |
112 | | -# Output file base name for HTML help builder. |
113 | | -htmlhelp_basename = "annofabapidoc" |
114 | | - |
115 | | - |
116 | | -# -- Options for LaTeX output ------------------------------------------------ |
117 | | - |
118 | | -latex_elements = { |
119 | | - # The paper size ('letterpaper' or 'a4paper'). |
120 | | - # |
121 | | - # 'papersize': 'letterpaper', |
122 | | - # The font size ('10pt', '11pt' or '12pt'). |
123 | | - # |
124 | | - # 'pointsize': '10pt', |
125 | | - # Additional stuff for the LaTeX preamble. |
126 | | - # |
127 | | - # 'preamble': '', |
128 | | - # Latex figure (float) alignment |
129 | | - # |
130 | | - # 'figure_align': 'htbp', |
| 53 | +html_theme_options = { |
| 54 | + "github_url": "https://github.com/kurusugawa-computer/annofab-api-python-client", |
131 | 55 | } |
132 | 56 |
|
133 | | -# Grouping the document tree into LaTeX files. List of tuples |
134 | | -# (source start file, target name, title, |
135 | | -# author, documentclass [howto, manual, or own class]). |
136 | | -latex_documents = [ |
137 | | - (master_doc, "annofabapi.tex", "annofabapi Documentation", "yuji38kwmt", "manual"), |
138 | | -] |
139 | | - |
140 | | - |
141 | | -# -- Options for manual page output ------------------------------------------ |
142 | | - |
143 | | -# One entry per manual page. List of tuples |
144 | | -# (source start file, name, description, authors, manual section). |
145 | | -man_pages = [(master_doc, "annofabapi", "annofabapi Documentation", [author], 1)] |
146 | | - |
147 | | - |
148 | | -# -- Options for Texinfo output ---------------------------------------------- |
149 | | - |
150 | | -# Grouping the document tree into Texinfo files. List of tuples |
151 | | -# (source start file, target name, title, author, |
152 | | -# dir menu entry, description, category) |
153 | | -texinfo_documents = [ |
154 | | - ( |
155 | | - master_doc, |
156 | | - "annofabapi", |
157 | | - "annofabapi Documentation", |
158 | | - author, |
159 | | - "annofabapi", |
160 | | - "One line description of project.", |
161 | | - "Miscellaneous", |
162 | | - ), |
163 | | -] |
164 | | - |
165 | | - |
166 | | -# -- Options for Epub output ------------------------------------------------- |
167 | | - |
168 | | -# Bibliographic Dublin Core info. |
169 | | -epub_title = project |
170 | | - |
171 | | -# The unique identifier of the text. This can be a ISBN number |
172 | | -# or the project homepage. |
173 | | -# |
174 | | -# epub_identifier = '' |
175 | | - |
176 | | -# A unique identification for the text. |
177 | | -# |
178 | | -# epub_uid = '' |
179 | | - |
180 | | -# A list of files that should not be packed into the epub file. |
181 | | -epub_exclude_files = ["search.html"] |
| 57 | +html_logo = "img/logo_landscape.png" |
0 commit comments