Skip to content

Commit 885e28e

Browse files
committed
readthedocs
1 parent 37face5 commit 885e28e

2 files changed

Lines changed: 173 additions & 1 deletion

File tree

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@
8989
html_theme_options = {
9090
'show_powered_by': False,
9191
'github_user': 'astorfi',
92-
'github_repo': 'TensorFlow-World',
92+
'github_repo': 'speech-feature-extraction',
9393
'github_banner': True,
9494
'show_related': False
9595
}

docs/conf.py~

Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
# -*- coding: utf-8 -*-
2+
#
3+
# speech feature extraction documentation build configuration file, created by
4+
# sphinx-quickstart on Thu Jun 29 10:33:57 2017.
5+
#
6+
# This file is execfile()d with the current directory set to its
7+
# containing dir.
8+
#
9+
# Note that not all possible configuration values are present in this
10+
# autogenerated file.
11+
#
12+
# All configuration values have a default; values that are commented out
13+
# serve to show the default.
14+
15+
# If extensions (or modules to document with autodoc) are in another directory,
16+
# add these directories to sys.path here. If the directory is relative to the
17+
# documentation root, use os.path.abspath to make it absolute, like shown here.
18+
#
19+
# import os
20+
# import sys
21+
# sys.path.insert(0, os.path.abspath('.'))
22+
23+
24+
# -- General configuration ------------------------------------------------
25+
26+
# If your documentation needs a minimal Sphinx version, state it here.
27+
#
28+
# needs_sphinx = '1.0'
29+
30+
# Add any Sphinx extension module names here, as strings. They can be
31+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32+
# ones.
33+
extensions = ['sphinx.ext.autodoc',
34+
'sphinx.ext.mathjax',
35+
'sphinx.ext.viewcode',
36+
'sphinx.ext.githubpages']
37+
38+
# Add any paths that contain templates here, relative to this directory.
39+
templates_path = ['_templates']
40+
41+
# The suffix(es) of source filenames.
42+
# You can specify multiple suffix as a list of string:
43+
#
44+
# source_suffix = ['.rst', '.md']
45+
source_suffix = '.rst'
46+
47+
# The master toctree document.
48+
master_doc = 'index'
49+
50+
# General information about the project.
51+
copyright = u'2017, Amirsina Torfi'
52+
author = u'Amirsina Torfi'
53+
54+
# The version info for the project you're documenting, acts as replacement for
55+
# |version| and |release|, also used in various other places throughout the
56+
# built documents.
57+
#
58+
# The short X.Y version.
59+
version = u'1.0'
60+
# The full version, including alpha/beta/rc tags.
61+
release = u'1.0'
62+
63+
# The language for content autogenerated by Sphinx. Refer to documentation
64+
# for a list of supported languages.
65+
#
66+
# This is also used if you do content translation via gettext catalogs.
67+
# Usually you set "language" from the command line for these cases.
68+
language = None
69+
70+
# List of patterns, relative to source directory, that match files and
71+
# directories to ignore when looking for source files.
72+
# This patterns also effect to html_static_path and html_extra_path
73+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
74+
75+
# The name of the Pygments (syntax highlighting) style to use.
76+
pygments_style = 'sphinx'
77+
78+
# If true, `todo` and `todoList` produce output, else they produce nothing.
79+
todo_include_todos = False
80+
81+
82+
# -- Options for HTML output ----------------------------------------------
83+
84+
# The theme to use for HTML and HTML Help pages. See the documentation for
85+
# a list of builtin themes.
86+
#
87+
html_theme = 'alabaster'
88+
89+
html_theme_options = {
90+
'show_powered_by': False,
91+
'github_user': 'astorfi',
92+
'github_repo': 'TensorFlow-World',
93+
'github_banner': True,
94+
'show_related': False
95+
}
96+
97+
# Theme options are theme-specific and customize the look and feel of a theme
98+
# further. For a list of options available for each theme, see the
99+
# documentation.
100+
#
101+
# html_theme_options = {}
102+
103+
# Add any paths that contain custom static files (such as style sheets) here,
104+
# relative to this directory. They are copied after the builtin static files,
105+
# so a file named "default.css" will overwrite the builtin "default.css".
106+
html_static_path = ['_static']
107+
108+
109+
# -- Options for HTMLHelp output ------------------------------------------
110+
111+
# Output file base name for HTML help builder.
112+
htmlhelp_basename = 'speechfeatureextractiondoc'
113+
114+
# If true, links to the reST sources are added to the pages.
115+
html_show_sourcelink = False
116+
117+
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
118+
html_show_sphinx = False
119+
120+
121+
# -- Options for LaTeX output ---------------------------------------------
122+
123+
latex_elements = {
124+
# The paper size ('letterpaper' or 'a4paper').
125+
#
126+
# 'papersize': 'letterpaper',
127+
128+
# The font size ('10pt', '11pt' or '12pt').
129+
#
130+
# 'pointsize': '10pt',
131+
132+
# Additional stuff for the LaTeX preamble.
133+
#
134+
# 'preamble': '',
135+
136+
# Latex figure (float) alignment
137+
#
138+
# 'figure_align': 'htbp',
139+
}
140+
141+
# Grouping the document tree into LaTeX files. List of tuples
142+
# (source start file, target name, title,
143+
# author, documentclass [howto, manual, or own class]).
144+
latex_documents = [
145+
(master_doc, 'speechfeatureextraction.tex', u'speech feature extraction Documentation',
146+
u'Amirsina Torfi', 'manual'),
147+
]
148+
149+
150+
# -- Options for manual page output ---------------------------------------
151+
152+
# One entry per manual page. List of tuples
153+
# (source start file, name, description, authors, manual section).
154+
man_pages = [
155+
(master_doc, 'speechfeatureextraction', u'speech feature extraction Documentation',
156+
[author], 1)
157+
]
158+
159+
160+
# -- Options for Texinfo output -------------------------------------------
161+
162+
# Grouping the document tree into Texinfo files. List of tuples
163+
# (source start file, target name, title, author,
164+
# dir menu entry, description, category)
165+
texinfo_documents = [
166+
(master_doc, 'speechfeatureextraction', u'speech feature extraction Documentation',
167+
author, 'speechfeatureextraction', 'One line description of project.',
168+
'Miscellaneous'),
169+
]
170+
171+
172+

0 commit comments

Comments
 (0)