Skip to content

Commit 1dafbf4

Browse files
author
Sam Kleinman
committed
build: creating manpage builds and tweaking footer punctuation.
1 parent 54d807d commit 1dafbf4

File tree

3 files changed

+31
-37
lines changed

3 files changed

+31
-37
lines changed

conf.py

Lines changed: 28 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434

3535
# General information about the project.
3636
project = u'MongoDB'
37-
copyright = u'2011-2012, 10gen, Inc'
37+
copyright = u'2011-2012, 10gen, Inc.'
3838

3939
# The version info for the project you're documenting, acts as replacement for
4040
# |version| and |release|, also used in various other places throughout the
@@ -134,9 +134,6 @@
134134
# using the given strftime format.
135135
html_last_updated_fmt = '%b %d, %Y'
136136

137-
# If true, SmartyPants will be used to convert quotes and dashes to
138-
# typographically correct entities.
139-
140137
html_use_smartypants = True
141138
html_domain_indices = True
142139
html_use_index = True
@@ -158,51 +155,48 @@
158155

159156
# -- Options for LaTeX output --------------------------------------------------
160157

161-
# The paper size ('letter' or 'a4').
162-
#latex_paper_size = 'letter'
163-
164-
# The font size ('10pt', '11pt' or '12pt').
165-
#latex_font_size = '10pt'
166-
167-
# Grouping the document tree into LaTeX files. List of tuples
168-
# (source start file, target name, title, author, documentclass [howto/manual]).
169158
latex_documents = [
170-
('contents', 'MongoDB.tex', u'MongoDB Documentation',
171-
u'MongoDB Documentation Project', 'manual'),
159+
# (source start file, target name, title, author, documentclass [howto/manual]).
160+
('contents', 'MongoDB.tex', u'MongoDB Documentation', u'MongoDB Documentation Project', 'manual'),
172161
]
173162

174-
# The name of an image file (relative to this directory) to place at the top of
175-
# the title page.
176-
#latex_logo = None
177-
178-
# For "manual" documents, if this is true, then toplevel headings are parts,
179-
# not chapters.
180-
#latex_use_parts = False
181-
182-
# If true, show page references after internal links.
183-
#latex_show_pagerefs = False
163+
latex_elements = { 'preamble': '\DeclareUnicodeCharacter{FF04}{\$} \DeclareUnicodeCharacter{FF0E}{.}',
164+
'pointsize': '10pt',
165+
'papersize': 'letterpaper'
166+
}
184167

185-
# If true, show URL addresses after external links.
168+
latex_use_parts = True
169+
latex_show_pagerefs = True
186170
latex_show_urls = False
171+
latex_domain_indices = True
187172

188-
# Additional stuff for the LaTeX preamble.
189-
#latex_preamble = ''
173+
# The name of an image file (relative to this directory) to place at the top of the title page.
174+
#latex_logo = None
190175

191176
# Documents to append as an appendix to all manuals.
192177
#latex_appendices = []
193178

194-
# If false, no module index is generated.
195-
latex_domain_indices = True
196-
197179
# -- Options for manual page output --------------------------------------------
198180

199-
# One entry per manual page. List of tuples
200-
# (source start file, name, description, authors, manual section).
201181
man_pages = [
202-
('index', 'mongodb', u'MongoDB Documentation',
203-
[u'MongoDB Documentation Project'], 1)
182+
# (source start file, name, description, authors, manual section).
183+
('contents', 'mongodb', u'MongoDB Manual', [u'MongoDB Documentation Project'], 1),
184+
('reference/bsondump', 'bsondump', u'MongoDB BSON utility', [u'MongoDB Documentation Project'], 1),
185+
('reference/mongo', 'mongo', u'MongoDB Shell', [u'MongoDB Documentation Project'], 1),
186+
('reference/mongod', 'mongod', u'MongoDB Server', [u'MongoDB Documentation Project'], 1),
187+
('reference/mongos', 'mongos', u'MongoDB Shard Utility', [u'MongoDB Documentation Project'], 1),
188+
('reference/mongodump', 'mongodump', u'MongoDB', [u'MongoDB Documentation Project'], 1),
189+
('reference/mongoexport', 'mongoexport', u'MongoDB', [u'MongoDB Documentation Project'], 1),
190+
('reference/mongofiles', 'mongofiles', u'MongoDB', [u'MongoDB Documentation Project'], 1),
191+
('reference/mongoimport', 'mongoimport', u'MongoDB', [u'MongoDB Documentation Project'], 1),
192+
('reference/mongooplog', 'mongooplog', u'MongoDB', [u'MongoDB Documentation Project'], 1),
193+
('reference/mongorestore', 'mongorestore', u'MongoDB', [u'MongoDB Documentation Project'], 1),
194+
('reference/mongostat', 'mongostat', u'MongoDB', [u'MongoDB Documentation Project'], 1),
195+
('reference/mongosniff', 'mongosniff', u'MongoDB', [u'MongoDB Documentation Project'], 1),
196+
('reference/mongotop', 'mongotop', u'MongoDB', [u'MongoDB Documentation Project'], 1),
204197
]
205198

199+
206200
# -- Options for Epub output ---------------------------------------------------
207201

208202
# Bibliographic Dublin Core info.

makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ latexpdf:
152152
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
153153
@echo "Running LaTeX files through pdflatex..."
154154
$(MAKE) -C $(BUILDDIR)/latex all-pdf
155-
@echo "pdflatex finished; the Aspirational PDF files are in $(BUILDDIR)/latex."
155+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
156156

157157
######################################################################
158158
#

themes/mongodb/layout.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -197,9 +197,9 @@ <h3>{{ _('Navigation') }}</h3>
197197
<div class="footer">
198198
{%- if show_copyright %}
199199
{%- if hasdoc('copyright') %}
200-
{% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
200+
{% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }} {% endtrans %}
201201
{%- else %}
202-
{% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
202+
{% trans copyright=copyright|e %}&copy; Copyright {{ copyright }} {% endtrans %}
203203
{%- endif %}
204204
{%- endif %}
205205
{%- if last_updated %}

0 commit comments

Comments
 (0)