Skip to content

Commit fcf4cfa

Browse files
committed
doc: minor documentation fixes
Signed-off-by: Tatiana Leon <Tatiana.Leon@digi.com>
1 parent 3395cd1 commit fcf4cfa

File tree

3 files changed

+18
-19
lines changed

3 files changed

+18
-19
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22
/doc/_build
33
.idea
44
venv/
5+
/dist/

doc/conf.py

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -221,25 +221,25 @@
221221
# -- Options for LaTeX output ---------------------------------------------
222222

223223
latex_elements = {
224-
# The paper size ('letterpaper' or 'a4paper').
225-
#'papersize': 'letterpaper',
224+
# The paper size ('letterpaper' or 'a4paper').
225+
# 'papersize': 'letterpaper',
226226

227-
# The font size ('10pt', '11pt' or '12pt').
228-
#'pointsize': '10pt',
227+
# The font size ('10pt', '11pt' or '12pt').
228+
# 'pointsize': '10pt',
229229

230-
# Additional stuff for the LaTeX preamble.
231-
#'preamble': '',
230+
# Additional stuff for the LaTeX preamble.
231+
# 'preamble': '',
232232

233-
# Latex figure (float) alignment
234-
#'figure_align': 'htbp',
233+
# Latex figure (float) alignment
234+
# 'figure_align': 'htbp',
235235
}
236236

237237
# Grouping the document tree into LaTeX files. List of tuples
238238
# (source start file, target name, title,
239239
# author, documentclass [howto, manual, or own class]).
240240
latex_documents = [
241-
(master_doc, 'XBeePythonLibrary.tex', u'XBee Python Library Documentation',
242-
author, 'manual'),
241+
(master_doc, 'XBeePythonLibrary.tex', u'XBee Python Library Documentation',
242+
author, 'manual'),
243243
]
244244

245245
# The name of an image file (relative to this directory) to place at the top of
@@ -267,10 +267,8 @@
267267

268268
# One entry per manual page. List of tuples
269269
# (source start file, name, description, authors, manual section).
270-
man_pages = [
271-
(master_doc, 'XBeePythonLibrary', u'XBee Python Library Documentation',
272-
[author], 1)
273-
]
270+
man_pages = [(master_doc, 'XBeePythonLibrary',
271+
u'XBee Python Library Documentation', [author], 1)]
274272

275273
# If true, show URL addresses after external links.
276274
#man_show_urls = False
@@ -282,9 +280,9 @@
282280
# (source start file, target name, title, author,
283281
# dir menu entry, description, category)
284282
texinfo_documents = [
285-
(master_doc, 'XBeePythonLibrary', u'XBee Python Library Documentation',
286-
author, 'XBeePythonLibrary', 'One line description of project.',
287-
'Miscellaneous'),
283+
(master_doc, 'XBeePythonLibrary', u'XBee Python Library Documentation',
284+
author, 'XBeePythonLibrary', 'One line description of project.',
285+
'Miscellaneous'),
288286
]
289287

290288
# Documents to append as an appendix to all manuals.
@@ -405,4 +403,4 @@
405403

406404

407405
def setup(app):
408-
app.add_stylesheet("theme_overrides.css")
406+
app.add_css_file("theme_overrides.css")

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535

3636
with open(os.path.join(here, 'README.rst'), encoding='utf-8') as f:
3737
long_description = f.read()
38-
38+
3939
setup(
4040
name=about['__title__'],
4141
namespace_packages=['digi'],

0 commit comments

Comments
 (0)