-
Notifications
You must be signed in to change notification settings - Fork 9
/
conf.py
594 lines (488 loc) · 17.2 KB
/
conf.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
# -*- coding: utf-8 -*-
#
# sphynx-demo documentation build configuration file, created by
# sphinx-quickstart on Tue Aug 2 16:48:54 2016.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import os
import pathlib
import re
import subprocess
import requests
def get_cmake_project_version(cmakelists):
"""
Get the project version from a file
The function looks for project(<name> VERSION major.minor.patch)
:param cmakelists: The file to scan for the version
:return: A dict in the manner:
{
'major': int,
'minor': int,
'patch': int
}
"""
matches = re.findall(
r'project\(.*VERSION\s+(\d+)\.(\d+)\.(\d+)',
"".join(open(cmakelists, 'r').readlines()),
flags=re.MULTILINE)[0]
return {
'major': matches[0],
'minor': matches[1],
'patch': matches[2] }
def get_version(cmakelists):
"""
Get the project version from a file
The function looks for PRODUCT_MAJOR_VERSION, PRODUCT_MINOR_VERSION, and
PRODUCT_PATCH_VERSION in the given file
:param cmakelists: The file to scan for the version
:return: A dict in the manner:
{
'major': int,
'minor': int,
'patch': int
}
"""
version = {}
with open(cmakelists, 'r') as f:
for line in f:
if re.search('PRODUCT_MAJOR_VERSION', line):
version['major'] = line.split()[1][:-1]
if re.search('PRODUCT_MINOR_VERSION', line):
version['minor'] = line.split()[1][:-1]
if re.search('PRODUCT_PATCH_VERSION', line):
version['patch'] = line.split()[1][:-1]
if ('major' in version and
'minor' in version and
'patch' in version):
break
return version
def download_css(html_css_dir):
"""
Download the common theme of eProsima readthedocs documentation.
The theme is defined in a CSS file that is hosted in the eProsima GitHub
repository with the index of all eProsima product documentation
(https://github.com/eProsima/all-docs).
:param html_css_dir: The directory to save the CSS stylesheet.
:return: True if the file was downloaded and generated successfully.
False if not.
"""
url = (
'https://raw.githubusercontent.com/eProsima/all-docs/'
'master/source/_static/css/fiware_readthedocs.css')
try:
req = requests.get(url, allow_redirects=True, timeout=10)
except requests.RequestException as e:
print(
'Failed to download the CSS with the eProsima rtd theme.'
'Request Error: {}'.format(e)
)
return False
if req.status_code != 200:
print(
'Failed to download the CSS with the eProsima rtd theme.'
'Return code: {}'.format(req.status_code))
return False
os.makedirs(
os.path.dirname('{}/_static/css/'.format(html_css_dir)),
exist_ok=True)
theme_path = '{}/_static/css/eprosima_rtd_theme.css'.format(html_css_dir)
with open(theme_path, 'wb') as f:
try:
f.write(req.content)
except OSError:
print('Failed to create the file: {}'.format(theme_path))
return False
return True
def select_css(html_css_dir):
"""
Select CSS file with the website's template.
:param html_css_dir: The directory to save the CSS stylesheet.
:return: Returns a list of CSS files to be imported.
"""
common_css = '_static/css/eprosima_rtd_theme.css'
local_css = '_static/css/fiware_readthedocs.css'
if download_css(html_css_dir):
print('Applying common CSS style file: {}'.format(common_css))
return [common_css]
else:
print('Applying local CSS style file: {}'.format(local_css))
return [local_css]
def configure_doxyfile(
doxyfile_in,
doxyfile_out,
input_dir,
output_dir,
project_binary_docs_dir,
project_source_docs_dir
):
"""
Configure Doxyfile in the CMake style.
:param doxyfile_in: Path to input Doxygen configuration file
:param doxyfile_out: Path to output Doxygen configuration file
:param input_dir: CMakeLists.txt value of DOXYGEN_INPUT_DIR
:param output_dir: CMakeLists.txt value of DOXYGEN_OUTPUT_DIR
:param project_binary_dir: CMakeLists.txt value of PROJECT_BINARY_DOCS_DIR
:param project_source_dir: CMakeLists.txt value of PROJECT_SOURCE_DIR
"""
print('Configuring Doxyfile')
with open(doxyfile_in, 'r') as file:
filedata = file.read()
filedata = filedata.replace('@DOXYGEN_INPUT_DIR@', input_dir)
filedata = filedata.replace('@DOXYGEN_OUTPUT_DIR@', output_dir)
filedata = filedata.replace(
'@PROJECT_BINARY_DIR@', project_binary_docs_dir
)
filedata = filedata.replace(
'@PROJECT_SOURCE_DIR@', project_source_docs_dir
)
os.makedirs(os.path.dirname(doxyfile_out), exist_ok=True)
with open(doxyfile_out, 'w') as file:
file.write(filedata)
script_path = os.path.abspath(pathlib.Path(__file__).parent.absolute())
# Project directories
project_source_docs_dir = os.path.abspath('{}/rst'.format(script_path))
project_binary_dir = os.path.abspath('{}/../build'.format(script_path))
project_binary_docs_dir = os.path.abspath(
'{}/docs'.format(project_binary_dir)
)
output_dir = os.path.abspath('{}/doxygen'.format(project_binary_docs_dir))
doxygen_html = os.path.abspath(
'{}/doxygen/html'.format(project_binary_docs_dir)
)
# Doxyfile
doxyfile_in = os.path.abspath(
'{}/doxygen-config.in'.format(script_path)
)
doxyfile_out = os.path.abspath(
'{}/doxygen-config'.format(project_binary_docs_dir)
)
# Header files
input_dir = os.path.abspath(
'{}/../include/fastdds_statistics_backend'.format(
script_path
)
)
# Check if we're running on Read the Docs' servers
read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
if read_the_docs_build:
print('Read the Docs environment detected!')
os.makedirs(os.path.dirname(output_dir), exist_ok=True)
os.makedirs(os.path.dirname(doxygen_html), exist_ok=True)
# Create a COLCON_IGNORE file just in case
open(
os.path.abspath('{}/COLCON_IGNORE'.format(project_binary_dir)), 'w'
).close()
# Configure Doxyfile
configure_doxyfile(
doxyfile_in,
doxyfile_out,
input_dir,
output_dir,
project_binary_docs_dir,
project_source_docs_dir
)
# Generate doxygen documentation
subprocess.call('doxygen {}'.format(doxyfile_out), shell=True)
breathe_projects = {
'fastdds_statistics_backend': os.path.abspath('{}/xml'.format(output_dir))
}
breathe_default_project = 'fastdds_statistics_backend'
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'breathe',
'sphinx.ext.todo',
]
try:
import sphinxcontrib.spelling # noqa: F401
extensions.append('sphinxcontrib.spelling')
# spelling_word_list_filename = 'spelling_wordlist.txt'
spelling_word_list_filename = [
'rst/spelling_wordlist.txt',
]
from sphinxcontrib.spelling.filters import ContractionFilter
spelling_filters = [ContractionFilter]
spelling_ignore_contributor_names = False
except ImportError:
pass
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The encoding of source files.
#
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'Fast DDS Statistics Backend'
copyright = u'2021, eProsima'
author = u'eProsima'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
versions = get_cmake_project_version(
os.path.abspath('{}/../CMakeLists.txt'.format(script_path)))
version = u'{}.{}'.format(versions['major'], versions['minor'])
# The full version, including alpha/beta/rc tags.
release = u'{}.{}.{}'.format(
versions['major'], versions['minor'], versions['patch'])
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'en'
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#
# today = ''
#
# Else, today_fmt is used as the format for a strftime call.
#
# today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = [
'*/includes/*.rst',
'*/*/includes/*.rst',
'*/*/*/includes/*.rst',
'*/*/*/*/includes/*.rst'
]
# The reST default role (used for this markup: `text`) to use for all
# documents.
#
# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#
# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#
# add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
# keep_warnings = False
suppress_warnings = [
'cpp.duplicate_declaration',
'cpp.parse_function_declaration'
]
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
#
# html_title = u'sphynx-demo v0.0.1'
# A shorter title for the navigation bar. Default is the same as html_title.
#
# html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#
# html_logo = None
# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#
# html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['rst/_static']
html_context = {
'css_files': select_css(project_source_docs_dir),
}
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#
# html_extra_path = []
# If not None, a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format.
# The empty string is equivalent to '%b %d, %Y'.
#
# html_last_updated_fmt = None
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#
# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#
# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#
# html_additional_pages = {}
# If false, no module index is generated.
#
# html_domain_indices = True
# If false, no index is generated.
#
# html_use_index = True
# If true, the index is split into individual pages for each letter.
#
# html_split_index = False
# If true, links to the reST sources are added to the pages.
#
# html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#
# html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#
# html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#
# html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None
# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
#
# html_search_language = 'en'
# A dictionary with options for the search language support, empty by default.
# 'ja' uses this config value.
# 'zh' user can custom change `jieba` dictionary path.
#
# html_search_options = {'type': 'default'}
# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#
# html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
htmlhelp_basename = 'FastDDS Statistics Backend Manual'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# 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,
'fastdds_statistics_backend.tex',
u'Fast DDS Statistics Backend Documentation',
u'eProsima',
'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#
# latex_logo = 01-figures/logo.png
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#
# latex_use_parts = False
# If true, show page references after internal links.
#
# latex_show_pagerefs = False
# If true, show URL addresses after external links.
#
# latex_show_urls = False
# Documents to append as an appendix to all manuals.
#
# latex_appendices = []
# It false, will not define \strong, \code, itleref, \crossref ... but only
# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
# packages.
#
# latex_keep_old_macro_names = True
# If false, no module index is generated.
#
# latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc,
'Fast DDS Statistics Backend',
u'Fast DDS Statistics Backend Documentation',
[author],
1)
]
# If true, show URL addresses after external links.
#
# man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc,
'Fast DDS Statistics Backend',
u'Fast DDS Statistics Backend Documentation',
author,
'Fast DDS Statistics Backend',
'Documentation of eProsima Fast DDS Statistics Backend',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#
# texinfo_appendices = []
# If false, no module index is generated.
#
# texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#
# texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#
# texinfo_no_detailmenu = False