Skip to content

Commit

Permalink
simplify name for PDF doc, generate zip file of docs
Browse files Browse the repository at this point in the history
  • Loading branch information
newville committed Apr 21, 2024
1 parent 929fb7f commit c3c8cde
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,10 @@ PAPER =
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
PDFFILE = uncertaintiesPythonPackage.pdf
PDFFILE = uncertainties.pdf

.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest

# The HTML needs pdf because it contains a link to the PDF version:
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
@echo
Expand All @@ -24,6 +23,7 @@ htmlpdf: pdf
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
-cp _build/latex/$(PDFFILE) _build/html/$(PDFFILE)
@echo
-cd _build && ln -s html uncertainties_doc && zip -pur uncertainties_doc.zip uncertainties_doc/* && mv uncertainties_doc.zip html
@echo "Build finished. The HTML pages are in _build/html."

help:
Expand Down
6 changes: 3 additions & 3 deletions doc/_templates/indexsidebar.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ <h3> Get <tt>uncertainties</tt></h3>
</p>


<h3>OFfline Documentation</h3>
<h3>Offline Documentation</h3>

<p>
<a href="uncertainties.pdf">PDF</a>
<a href="uncertainties.pdf">uncertainties.pdf</a>
<br>
<a href="uncertainties_doc.zip">HTML (zip)</a>
<a href="uncertainties_doc.zip">Zipped HTML and PDF</a>
</p>

4 changes: 2 additions & 2 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@
#html_file_suffix = ''

# Output file base name for HTML help builder.
htmlhelp_basename = 'uncertaintiesdoc'
htmlhelp_basename = 'uncertainties'


# -- Options for LaTeX output --------------------------------------------------
Expand All @@ -178,7 +178,7 @@
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'uncertaintiesPythonPackage.tex', u'uncertainties Python package Documentation',
('index', 'uncertainties.tex', u'uncertainties Python package Documentation',
u'Eric O. LEBIGOT (EOL)', 'manual'),
]

Expand Down

0 comments on commit c3c8cde

Please sign in to comment.