Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 71 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,4 +82,74 @@ def setup(app):
# the docs. This file should be a Windows icon file (.ico) being 16x16 or
# 32x32 pixels large.
#
html_favicon = "static/favicon.ico"
html_favicon = "static/favicon.ico"

# -- Options for LaTeX output -------------------------------------------------------------------------------------------
latex_engine = 'lualatex'
latex_use_xindy = False

# latex config taken from connextdds repo
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt')
'pointsize': '11pt',
'preamble': '''\
\\sphinxsetup{TitleColor={named}{black},InnerLinkColor={named}{black},OuterLinkColor={named}{blue}}
\\usepackage[utf8]{inputenc}
\\usepackage[titles]{tocloft}
\\usepackage{multirow}
\\usepackage{newunicodechar}
\\usepackage{hyperref}
\\usepackage{fontspec}
\\usepackage{graphicx}
\\setkeys{Gin}{width=.85\\textwidth}
\\hypersetup{bookmarksnumbered}
\\setcounter{tocdepth}{3}
\\usepackage{fancyhdr}
\\setlength{\headheight}{14pt}
\\usepackage[draft]{minted}\\fvset{breaklines=true, breakanywhere=true}''',
'printindex': '\\footnotesize\\raggedright\\printindex',
'inputenc': '',
'utf8extra': '',
'classoptions': ',openany,oneside',
'releasename': 'Version',
'fncychap': '',
'maketitle': '''\
\\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{''' + project + '''}}
\\vspace{17mm}

\\textbf{\\Large{Version ''' + version + '''}}

\\vspace{100mm}
\\vspace{0mm}
\\end{titlepage}
'''
}

latex_use_modindex = True

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(
master_doc,
'rticonnectorforjavascript.tex',
'RTI Connector for Javascript',
'2021, Real-Time Innovations, Inc.',
'manual'
),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#
html_logo = "static/rti-logo-FINALv2-White-OrangeDot.png"
2 changes: 1 addition & 1 deletion docs/copyright_license.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Website: https://support.rti.com/ |br|
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ''AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
Expand Down
9 changes: 4 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@

.. highlight:: javascript

.. image:: static/RTI_Launcher_Icon_Connector_JavaScript_100x100_0919_forDocumentation.png
:align: left
.. only:: html

.. image:: static/RTI_Launcher_Icon_Connector_JavaScript_100x100_0919_forDocumentation.png
:align: left

Welcome to RTI Connector for JavaScript!
========================================
Expand All @@ -19,9 +21,6 @@ You can learn how to use *RTI Connector* by reading the following sections, whic
include examples and detailed API reference. You can also find a specific type
or function in the :ref:`genindex`.

Table of Contents
=================

.. toctree::
:maxdepth: 2
:numbered:
Expand Down
Loading