Skip to content

Commit beacff7

Browse files
committed
Updated documentation
1 parent c47ad1d commit beacff7

4 files changed

Lines changed: 8259 additions & 14 deletions

File tree

docs/source/conf.py

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@
1717

1818

1919
# register hal lexer
20-
lexers['hal'] = HALLexer()
20+
lexers["hal"] = HALLexer()
2121

2222

2323
# -- Project information -----------------------------------------------------
2424
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
2525

26-
project = "Robot Grúa del CITIC"
27-
copyright = "2025, GTEC"
28-
author = "GTEC"
26+
project = "LinuxCNC Motor Control Testbed"
27+
author = "Tomás Domínguez Bolaño, Valentín Barral Vales, Carlos José Escudero Cascón, and José Antonio García Naya (CITIC Research Center, University of A Coruña, Spain)"
28+
copyright = "2025, Group of Electronic Technology and Communications of the University of A Coruña (UDC)"
2929

3030

3131
# -- General configuration ---------------------------------------------------
@@ -35,7 +35,7 @@
3535
"sphinxcontrib.bibtex", # https://github.com/mcmtroffaes/sphinxcontrib-bibtex
3636
"sphinx_copybutton", # https://github.com/executablebooks/sphinx-copybutton
3737
"extimage", # Provides ext-image and ext-figure directives
38-
'myst_parser', # https://myst-parser.readthedocs.io/en/latest/
38+
"myst_parser", # https://myst-parser.readthedocs.io/en/latest/
3939
]
4040

4141
bibtex_bibfiles = ["bib/references.bib"]
@@ -56,17 +56,15 @@
5656
"substitution",
5757
]
5858

59-
myst_substitutions = {
60-
"project": project
61-
}
59+
myst_substitutions = {"project": project}
6260

6361
numfig = True
6462
numfig_secnum_depth = 0
6563
math_numfig = True
6664
highlight_language = "none"
6765

6866
numfig_format = {
69-
'code-block': 'Código %s',
67+
"code-block": "Código %s",
7068
# 'figure': 'Figura %s',
7169
# 'section': 'Sección',
7270
# 'table': 'Tabla %s',
@@ -118,7 +116,7 @@
118116

119117
html_theme = "furo"
120118

121-
html_title = "Documentación del " + project
119+
html_title = project
122120

123121
html_theme_options = {
124122
# furo theme options
@@ -140,7 +138,7 @@
140138
"css/custom.css",
141139
# "css/furo_custom.css",
142140
# "css/sphynx_copybutton.css",
143-
"css/tables.css"
141+
"css/tables.css",
144142
]
145143

146144
html_logo = "images/logos/logo_udc_gtec_citic.svg"
@@ -158,6 +156,15 @@
158156

159157
latex_logo = "images/logos/logo_udc_gtec_citic.pdf"
160158

159+
latex_documents = [
160+
(
161+
"index",
162+
"linuxcncmotorcontroltestbed.tex",
163+
project,
164+
"Tomás Domínguez Bolaño \\and Valentín Barral Vales \\and Carlos José Escudero Cascón \\and José Antonio García Naya",
165+
"manual",
166+
)
167+
]
161168

162169
# Additional documents to include
163170
latex_additional_files = [
@@ -213,7 +220,9 @@
213220
"""
214221
),
215222
"pointsize": "11pt",
216-
"preamble": r"\input{preamble.sty}",
223+
"preamble": r"\input{preamble.sty}"
224+
+ "\n"
225+
+ r"\authoraddress{CITIC Research Center, University of A Coruña, Spain}",
217226
"sphinxsetup": textwrap.dedent(
218227
r"""
219228
hmargin=115pt,
669 KB
Binary file not shown.

0 commit comments

Comments
 (0)