Skip to content

Commit

Permalink
read the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@astorfi
astorfi committed Nov 23, 2017
1 parent d09a546 commit e2534a8
Show file tree
Hide file tree
Showing 11 changed files with 335 additions and 670 deletions.
Empty file removed docs/requirements.txt~
View file
Empty file.
348 changes: 174 additions & 174 deletions docs/source/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -138,186 +138,186 @@

# -- Options for LaTeX output ---------------------------------------------

latex_engine = 'pdflatex'

# latex_engine = 'xelatex'
# latex_elements = {
#
# 'papersize': 'a4paper',
# 'releasename':" ",
# 'figure_align':'htbp',
# 'pointsize': '12pt',
# 'fontpkg': r'''
# \setmainfont{Times New Roman}
# \setsansfont{Times New Roman}
# \setmonofont{Times New Roman}
# ''',
# 'preamble': r'''
# \usepackage[titles]{tocloft}
# \cftsetpnumwidth {1.25cm}\cftsetrmarg{1.5cm}
# \setlength{\cftchapnumwidth}{0.75cm}
# \setlength{\cftsecindent}{\cftchapnumwidth}
# \setlength{\cftsecnumwidth}{1.25cm}
# ''',
# 'fncychap': r'\usepackage[Bjornstrup]{fncychap}',
# 'printindex': r'\footnotesize\raggedright\printindex',
# }

latex_logo = '_static/img/speechpy_logo.jpg'

# latex_engine = 'pdflatex'

latex_engine = 'xelatex'
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
'papersize': 'a4paper',
'releasename':" ",
# Sonny, Lenny, Glenn, Conny, Rejne, Bjarne and Bjornstrup
# 'fncychap': '\\usepackage[Lenny]{fncychap}',
'fncychap': '\\usepackage{fncychap}',
# 'fontpkg': ' ',

'papersize': 'a4paper',
'releasename':" ",
'figure_align':'htbp',
# The font size ('10pt', '11pt' or '12pt').
#
'pointsize': '14pt',

# Additional stuff for the LaTeX preamble.

# 'preamble': r'''
# %%%%%%%%%%%%%%%%%%%% Sina %%%%%%%%%%%%%%%%%%
# %%%add number to subsubsection 2=subsection, 3=subsubsection
# %%% below subsubsection is not good idea.
# \setcounter{secnumdepth}{3}
# %
# %%%% Table of content upto 2=subsection, 3=subsubsection
# %\setcounter{tocdepth}{2}
#
# \usepackage{amsmath,amsfonts,amssymb,amsthm}
# \usepackage{graphicx}
#
# %\usepackage{minted}
# %\fvset{breaklines=true}
#
# %%% reduce spaces for Table of contents, figures and tables
# %%% it is used "\addtocontents{toc}{\vskip -1.2cm}" etc. in the document
# \usepackage[notlot,nottoc,notlof]{}
#
# \usepackage{color}
# \usepackage{transparent}
# \usepackage{eso-pic}
# \usepackage{lipsum}
#
# \usepackage{footnotebackref} %%link at the footnote to go to the place of footnote in the text
#
# %% spacing between line
# \usepackage{setspace}
# %%%%\onehalfspacing
# %%%%\doublespacing
# %\singlespacing
#
#
# %%%%%%%%%%% datetime
# \usepackage{datetime}
#
# \newdateformat{MonthYearFormat}{%
# \monthname[\THEMONTH], \THEYEAR}
#
#
# %% RO, LE will not work for 'oneside' layout.
# %% Change oneside to twoside in document class
# %\usepackage{fancyhdr}
# %\pagestyle{fancy}
# %\fancyhf{}
#
# %%% Alternating Header for oneside
# %\fancyhead[L]{\ifthenelse{\isodd{\value{page}}}{ \small \nouppercase{\leftmark} }{}}
# %\fancyhead[R]{\ifthenelse{\isodd{\value{page}}}{}{ \small \nouppercase{\rightmark} }}
#
# %%% Alternating Header for two side
# %\fancyhead[RO]{\small \nouppercase{\rightmark}}
# %\fancyhead[LE]{\small \nouppercase{\leftmark}}
#
# %% for oneside: change footer at right side. If you want to use Left and right then use same as header defined above.
# %\fancyfoot[R]{\ifthenelse{\isodd{\value{page}}}{{\tiny Amirsina Torfi} }{\href{https://github.com/astorfi/speechpy}{\tiny SpeechPy}}}
#
# %%% Alternating Footer for two side
# %\fancyfoot[RO, RE]{\scriptsize Amirsina Torfi ([email protected])}
#
# %%% page number
# %\fancyfoot[CO, CE]{\thepage}
#
# %\renewcommand{\headrulewidth}{0.5pt}
# %\renewcommand{\footrulewidth}{0.5pt}
#
# %\RequirePackage{tocbibind} %%% comment this to remove page number for following
# %\addto\captionsenglish{\renewcommand{\contentsname}{Table of contents}}
# %\addto\captionsenglish{\renewcommand{\listfigurename}{List of figures}}
# %\addto\captionsenglish{\renewcommand{\listtablename}{List of tables}}
# %\addto\captionsenglish{\renewcommand{\listtablename}{List of tables}} %%% Heading for TOC
#
#
# %%reduce spacing for itemize
# \usepackage{enumitem}
# %\setlist{nosep}
#
# %%%%%%%%%%% Quote Styles at the top of chapter
# %\usepackage{epigraph}
# %\setlength{\epigraphwidth}{0.8\columnwidth}
# %\newcommand{\chapterquote}[2]{\epigraphhead[60]{\epigraph{\textit{#1}}{\textbf {\textit{--#2}}}}}
# %%%%%%%%%%% Quote for all places except Chapter
# %\newcommand{\sectionquote}[2]{{\quote{\textit{``#1''}}{\textbf {\textit{--#2}}}}}
# ''',
#
#
# 'maketitle': r'''
# \pagenumbering{Roman} %%% to avoid page 1 conflict with actual page 1
#
# \begin{titlepage}
# \centering
#
# \vspace*{40mm} %%% * is used to give space from top
# \textbf{\Huge {SpeechPy: Speech Recognition Library}}
#
# \vspace{0mm}
# \begin{figure}[!h]
# \centering
# \includegraphics[scale=0.8]{speechpy_logo.jpg}
# \end{figure}
#
# \vspace{0mm}
# \Large \textbf{{Amirsina Torfi}}
#
# % \small Created on : Octorber, 2017
#
# \vspace*{0mm}
# \small Last updated : \MonthYearFormat\today
#
#
# %% \vfill adds at the bottom
# \vfill
# \small \textit{Please refer to project repository at }{\href{https://github.com/astorfi/speechpy}{SpeechPy}}
# \end{titlepage}
#
# \clearpage
# \pagenumbering{roman}
# \tableofcontents
# % \listoffigures
# % \listoftables
# \clearpage
# \pagenumbering{english}
#
# ''',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
# 'sphinxsetup': \
# #'hmargin={0.7in,0.7in}, vmargin={1in,1in}, \
# 'verbatimwithframe=true, \
# TitleColor={rgb}{0,0,0}',
# 'tableofcontents':' ',

'pointsize': '12pt',
'fontpkg': r'''
\setmainfont{Times New Roman}
\setsansfont{Times New Roman}
\setmonofont{Times New Roman}
''',
'preamble': r'''
\usepackage[titles]{tocloft}
\cftsetpnumwidth {1.25cm}\cftsetrmarg{1.5cm}
\setlength{\cftchapnumwidth}{0.75cm}
\setlength{\cftsecindent}{\cftchapnumwidth}
\setlength{\cftsecnumwidth}{1.25cm}
''',
'fncychap': r'\usepackage[Bjornstrup]{fncychap}',
'printindex': r'\footnotesize\raggedright\printindex',
}

latex_logo = '_static/img/speechpy_logo.jpg'


# latex_elements = {
# # The paper size ('letterpaper' or 'a4paper').
# #
# 'papersize': 'a4paper',
# 'releasename':" ",
# # Sonny, Lenny, Glenn, Conny, Rejne, Bjarne and Bjornstrup
# # 'fncychap': '\\usepackage[Lenny]{fncychap}',
# 'fncychap': '\\usepackage{fncychap}',
# # 'fontpkg': ' ',
#
# 'figure_align':'htbp',
# # The font size ('10pt', '11pt' or '12pt').
# #
# 'pointsize': '14pt',
#
# # Additional stuff for the LaTeX preamble.
#
# # 'preamble': r'''
# # %%%%%%%%%%%%%%%%%%%% Sina %%%%%%%%%%%%%%%%%%
# # %%%add number to subsubsection 2=subsection, 3=subsubsection
# # %%% below subsubsection is not good idea.
# # \setcounter{secnumdepth}{3}
# # %
# # %%%% Table of content upto 2=subsection, 3=subsubsection
# # %\setcounter{tocdepth}{2}
# #
# # \usepackage{amsmath,amsfonts,amssymb,amsthm}
# # \usepackage{graphicx}
# #
# # %\usepackage{minted}
# # %\fvset{breaklines=true}
# #
# # %%% reduce spaces for Table of contents, figures and tables
# # %%% it is used "\addtocontents{toc}{\vskip -1.2cm}" etc. in the document
# # \usepackage[notlot,nottoc,notlof]{}
# #
# # \usepackage{color}
# # \usepackage{transparent}
# # \usepackage{eso-pic}
# # \usepackage{lipsum}
# #
# # \usepackage{footnotebackref} %%link at the footnote to go to the place of footnote in the text
# #
# # %% spacing between line
# # \usepackage{setspace}
# # %%%%\onehalfspacing
# # %%%%\doublespacing
# # %\singlespacing
# #
# #
# # %%%%%%%%%%% datetime
# # \usepackage{datetime}
# #
# # \newdateformat{MonthYearFormat}{%
# # \monthname[\THEMONTH], \THEYEAR}
# #
# #
# # %% RO, LE will not work for 'oneside' layout.
# # %% Change oneside to twoside in document class
# # %\usepackage{fancyhdr}
# # %\pagestyle{fancy}
# # %\fancyhf{}
# #
# # %%% Alternating Header for oneside
# # %\fancyhead[L]{\ifthenelse{\isodd{\value{page}}}{ \small \nouppercase{\leftmark} }{}}
# # %\fancyhead[R]{\ifthenelse{\isodd{\value{page}}}{}{ \small \nouppercase{\rightmark} }}
# #
# # %%% Alternating Header for two side
# # %\fancyhead[RO]{\small \nouppercase{\rightmark}}
# # %\fancyhead[LE]{\small \nouppercase{\leftmark}}
# #
# # %% for oneside: change footer at right side. If you want to use Left and right then use same as header defined above.
# # %\fancyfoot[R]{\ifthenelse{\isodd{\value{page}}}{{\tiny Amirsina Torfi} }{\href{https://github.com/astorfi/speechpy}{\tiny SpeechPy}}}
# #
# # %%% Alternating Footer for two side
# # %\fancyfoot[RO, RE]{\scriptsize Amirsina Torfi ([email protected])}
# #
# # %%% page number
# # %\fancyfoot[CO, CE]{\thepage}
# #
# # %\renewcommand{\headrulewidth}{0.5pt}
# # %\renewcommand{\footrulewidth}{0.5pt}
# #
# # %\RequirePackage{tocbibind} %%% comment this to remove page number for following
# # %\addto\captionsenglish{\renewcommand{\contentsname}{Table of contents}}
# # %\addto\captionsenglish{\renewcommand{\listfigurename}{List of figures}}
# # %\addto\captionsenglish{\renewcommand{\listtablename}{List of tables}}
# # %\addto\captionsenglish{\renewcommand{\listtablename}{List of tables}} %%% Heading for TOC
# #
# #
# # %%reduce spacing for itemize
# # \usepackage{enumitem}
# # %\setlist{nosep}
# #
# # %%%%%%%%%%% Quote Styles at the top of chapter
# # %\usepackage{epigraph}
# # %\setlength{\epigraphwidth}{0.8\columnwidth}
# # %\newcommand{\chapterquote}[2]{\epigraphhead[60]{\epigraph{\textit{#1}}{\textbf {\textit{--#2}}}}}
# # %%%%%%%%%%% Quote for all places except Chapter
# # %\newcommand{\sectionquote}[2]{{\quote{\textit{``#1''}}{\textbf {\textit{--#2}}}}}
# # ''',
# #
# #
# # 'maketitle': r'''
# # \pagenumbering{Roman} %%% to avoid page 1 conflict with actual page 1
# #
# # \begin{titlepage}
# # \centering
# #
# # \vspace*{40mm} %%% * is used to give space from top
# # \textbf{\Huge {SpeechPy: Speech Recognition Library}}
# #
# # \vspace{0mm}
# # \begin{figure}[!h]
# # \centering
# # \includegraphics[scale=0.8]{speechpy_logo.jpg}
# # \end{figure}
# #
# # \vspace{0mm}
# # \Large \textbf{{Amirsina Torfi}}
# #
# # % \small Created on : Octorber, 2017
# #
# # \vspace*{0mm}
# # \small Last updated : \MonthYearFormat\today
# #
# #
# # %% \vfill adds at the bottom
# # \vfill
# # \small \textit{Please refer to project repository at }{\href{https://github.com/astorfi/speechpy}{SpeechPy}}
# # \end{titlepage}
# #
# # \clearpage
# # \pagenumbering{roman}
# # \tableofcontents
# # % \listoffigures
# # % \listoftables
# # \clearpage
# # \pagenumbering{english}
# #
# # ''',
# # Latex figure (float) alignment
# #
# # 'figure_align': 'htbp',
# # 'sphinxsetup': \
# # #'hmargin={0.7in,0.7in}, vmargin={1in,1in}, \
# # 'verbatimwithframe=true, \
# # TitleColor={rgb}{0,0,0}',
# # 'tableofcontents':' ',
#
# }



# Grouping the document tree into LaTeX files. List of tuples
Expand Down
Loading

0 comments on commit e2534a8

Please sign in to comment.