Skip to content

Commit 7e597ab

Browse files
committed
Formatting cleanups to prep for first pre-release
Formatting changes for release document - Change watermark to show date of document - Remove "Documentation" from title - use lowercase instead of CamelCase for filename Signed-off-by: Grant Likely <[email protected]>
1 parent 59681b5 commit 7e597ab

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

source/conf.py

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414

1515
import sys
1616
import os
17+
import time
1718

1819
# If extensions (or modules to document with autodoc) are in another directory,
1920
# add these directories to sys.path here. If the directory is relative to the
@@ -57,9 +58,9 @@
5758
# built documents.
5859
#
5960
# The short X.Y version.
60-
version = u'0.1'
61+
version = u'0.1-pre1'
6162
# The full version, including alpha/beta/rc tags.
62-
release = u'0.1'
63+
release = u'0.1-pre1-%s' % time.strftime('%Y%m%d')
6364

6465
# The language for content autogenerated by Sphinx. Refer to documentation
6566
# for a list of supported languages.
@@ -72,7 +73,7 @@
7273
# non-false value, then it is used:
7374
#today = ''
7475
# Else, today_fmt is used as the format for a strftime call.
75-
#today_fmt = '%B %d, %Y'
76+
today_fmt = '%d %B %Y'
7677

7778
# List of patterns, relative to source directory, that match files and
7879
# directories to ignore when looking for source files.
@@ -228,7 +229,7 @@
228229
#'pointsize': '10pt',
229230

230231
# Additional stuff for the LaTeX preamble.
231-
'preamble': '\\usepackage{draftwatermark}\\SetWatermarkText{DRAFT v%s}'%release,
232+
'preamble': '\\usepackage{draftwatermark}\\SetWatermarkScale{.45}\\SetWatermarkText{DRAFT v%s}' % release
232233

233234
# Latex figure (float) alignment
234235
#'figure_align': 'htbp',
@@ -238,7 +239,7 @@
238239
# (source start file, target name, title,
239240
# author, documentclass [howto, manual, or own class]).
240241
latex_documents = [
241-
(master_doc, 'DevicetreeSpecification.tex', u'Devicetree Specification Documentation',
242+
(master_doc, 'devicetree-specification.tex', u'Devicetree Specification',
242243
u'devicetree.org', 'manual'),
243244
]
244245

@@ -268,7 +269,7 @@
268269
# One entry per manual page. List of tuples
269270
# (source start file, name, description, authors, manual section).
270271
man_pages = [
271-
(master_doc, 'devicetreespecification', u'Devicetree Specification Documentation',
272+
(master_doc, 'devicetree-specification', u'Devicetree Specification',
272273
[author], 1)
273274
]
274275

@@ -282,8 +283,8 @@
282283
# (source start file, target name, title, author,
283284
# dir menu entry, description, category)
284285
texinfo_documents = [
285-
(master_doc, 'DevicetreeSpecification', u'Devicetree Specification Documentation',
286-
author, 'DevicetreeSpecification', 'One line description of project.',
286+
(master_doc, 'devicetree-specification', u'Devicetree Specification',
287+
author, 'DevicetreeSpecification', 'Devicetree hardware description language specification.',
287288
'Miscellaneous'),
288289
]
289290

0 commit comments

Comments
 (0)