1
- #!/usr/bin/env python3
2
- # -*- coding: utf-8 -*-
3
- #
4
- # This file is execfile()d with the current directory set to its
5
- # containing dir.
6
- #
7
- # If extensions (or modules to document with autodoc) are in another directory,
8
- # add these directories to sys.path here. If the directory is relative to the
9
- # documentation root, use os.path.abspath to make it absolute, like shown here.
10
- #
11
-
12
- __version__ = None
13
- exec (open ('../ib_insync/version.py' ).read ())
14
-
15
- # -- General configuration ------------------------------------------------
16
-
17
- # Add any Sphinx extension module names here, as strings. They can be
18
- # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
19
- # ones.
20
1
extensions = [
21
2
'sphinx.ext.autodoc' ,
22
3
'sphinx.ext.viewcode' ,
23
4
'sphinxcontrib.napoleon' ,
24
- 'sphinx_autodoc_typehints'
5
+ 'sphinx_autodoc_typehints' ,
25
6
]
26
7
27
- # Add any paths that contain templates here, relative to this directory.
28
8
templates_path = ['_templates' ]
29
-
30
- # The suffix(es) of source filenames.
31
- # You can specify multiple suffix as a list of string:
32
- #
33
- # source_suffix = ['.rst', '.md']
34
9
source_suffix = '.rst'
35
-
36
- # The master toctree document.
37
10
master_doc = 'index'
38
-
39
- # General information about the project.
40
- project = 'IB-insync'
11
+ project = 'ib_insync'
41
12
copyright = '2019, Ewald de Wit'
42
13
author = 'Ewald de Wit'
43
14
44
- # The version info for the project you're documenting, acts as replacement for
45
- # |version| and |release|, also used in various other places throughout the
46
- # built documents.
47
- #
48
- # The short X.Y version.
15
+ __version__ = None
16
+ exec (open ('../ib_insync/version.py' ).read ())
49
17
version = '.' .join (__version__ .split ('.' )[:2 ])
50
- # The full version, including alpha/beta/rc tags.
51
18
release = __version__
52
19
53
- # The language for content autogenerated by Sphinx. Refer to documentation
54
- # for a list of supported languages.
55
- #
56
- # This is also used if you do content translation via gettext catalogs.
57
- # Usually you set "language" from the command line for these cases.
58
20
language = None
59
-
60
- # List of patterns, relative to source directory, that match files and
61
- # directories to ignore when looking for source files.
62
- # This patterns also effect to html_static_path and html_extra_path
63
21
exclude_patterns = ['_build' , 'Thumbs.db' , '.DS_Store' ]
64
-
65
- # The name of the Pygments (syntax highlighting) style to use.
66
22
pygments_style = 'sphinx'
67
-
68
- # If true, `todo` and `todoList` produce output, else they produce nothing.
69
23
todo_include_todos = False
70
-
71
- # -- Options for HTML output ----------------------------------------------
72
-
73
- # The theme to use for HTML and HTML Help pages. See the documentation for
74
- # a list of builtin themes.
75
- #
76
- html_theme = 'alabaster'
77
-
78
- # Theme options are theme-specific and customize the look and feel of a theme
79
- # further. For a list of options available for each theme, see the
80
- # documentation.
81
- #
24
+ html_theme = 'sphinx_rtd_theme'
82
25
html_theme_options = {
83
- 'github_user' : 'erdewit' ,
84
- 'github_repo' : 'ib_insync' ,
85
- 'github_type' : 'star' ,
86
- 'page_width' : '65em' ,
87
- 'fixed_sidebar' : True ,
88
- 'link' : '#266' ,
89
- 'sidebar_link' : '#266' ,
90
- }
91
-
92
- # Add any paths that contain custom static files (such as style sheets) here,
93
- # relative to this directory. They are copied after the builtin static files,
94
- # so a file named "default.css" will overwrite the builtin "default.css".
95
- # html_static_path = ['_static']
96
-
97
- # Custom sidebar templates, must be a dictionary that maps document names
98
- # to template names.
99
- #
100
- # This is required for the alabaster theme
101
- # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
102
- html_sidebars = {
103
- '**' : [
104
- 'about.html' ,
105
- 'navigation.html' ,
106
- 'searchbox.html' ,
107
- 'donate.html' ,
108
- ]
26
+ 'canonical_url' : 'https://ib_insync.readthedocs.io' ,
27
+ 'logo_only' : False ,
28
+ 'display_version' : True ,
29
+ 'prev_next_buttons_location' : 'bottom' ,
30
+ 'style_external_links' : False ,
31
+ # Toc options
32
+ 'collapse_navigation' : True ,
33
+ 'sticky_navigation' : True ,
34
+ 'navigation_depth' : 4 ,
35
+ 'includehidden' : True ,
36
+ 'titles_only' : False
109
37
}
38
+ github_url = 'https://github.com/erdewit/ib_insync'
110
39
111
40
autoclass_content = 'both'
112
41
autodoc_member_order = "bysource"
@@ -126,28 +55,3 @@ def onDocstring(app, what, name, obj, options, lines):
126
55
127
56
def setup (app ):
128
57
app .connect ('autodoc-process-docstring' , onDocstring ),
129
-
130
- # -- Options for HTMLHelp output ------------------------------------------
131
-
132
-
133
- # Output file base name for HTML help builder.
134
- htmlhelp_basename = 'IB-insyncdoc'
135
-
136
-
137
- # Grouping the document tree into LaTeX files. List of tuples
138
- # (source start file, target name, title,
139
- # author, documentclass [howto, manual, or own class]).
140
- latex_documents = [
141
- (master_doc , 'IB-insync.tex' , 'IB-insync Documentation' ,
142
- 'Ewald de Wit' , 'manual' ),
143
- ]
144
-
145
- #
146
- # -- Options for manual page output ---------------------------------------
147
-
148
- # One entry per manual page. List of tuples
149
- # (source start file, name, description, authors, manual section).
150
- man_pages = [
151
- (master_doc , 'ib-insync' , 'IB-insync Documentation' ,
152
- [author ], 1 )
153
- ]
0 commit comments