Add Makefile and update docs dir structure for new Sphinx conventions. Use make html
in docs/ to rebuild.
130
docs/Makefile
Normal file
|
@ -0,0 +1,130 @@
|
|||
# Makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
PAPER =
|
||||
BUILDDIR = build
|
||||
|
||||
# Internal variables.
|
||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||
PAPEROPT_letter = -D latex_paper_size=letter
|
||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
||||
|
||||
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
|
||||
|
||||
help:
|
||||
@echo "Please use \`make <target>' where <target> is one of"
|
||||
@echo " html to make standalone HTML files"
|
||||
@echo " dirhtml to make HTML files named index.html in directories"
|
||||
@echo " singlehtml to make a single large HTML file"
|
||||
@echo " pickle to make pickle files"
|
||||
@echo " json to make JSON files"
|
||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||
@echo " qthelp to make HTML files and a qthelp project"
|
||||
@echo " devhelp to make HTML files and a Devhelp project"
|
||||
@echo " epub to make an epub"
|
||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||
@echo " text to make text files"
|
||||
@echo " man to make manual pages"
|
||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||
@echo " linkcheck to check all external links for integrity"
|
||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
|
||||
clean:
|
||||
-rm -rf $(BUILDDIR)/*
|
||||
|
||||
html:
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
dirhtml:
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||
|
||||
singlehtml:
|
||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||
|
||||
pickle:
|
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||
@echo
|
||||
@echo "Build finished; now you can process the pickle files."
|
||||
|
||||
json:
|
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||
@echo
|
||||
@echo "Build finished; now you can process the JSON files."
|
||||
|
||||
htmlhelp:
|
||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||
|
||||
qthelp:
|
||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/UCBerkeleyAstronomy10Spring2011.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/UCBerkeleyAstronomy10Spring2011.qhc"
|
||||
|
||||
devhelp:
|
||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||
@echo
|
||||
@echo "Build finished."
|
||||
@echo "To view the help file:"
|
||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/UCBerkeleyAstronomy10Spring2011"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/UCBerkeleyAstronomy10Spring2011"
|
||||
@echo "# devhelp"
|
||||
|
||||
epub:
|
||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||
@echo
|
||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||
|
||||
latex:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo
|
||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||
"(use \`make latexpdf' here to do that automatically)."
|
||||
|
||||
latexpdf:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through pdflatex..."
|
||||
make -C $(BUILDDIR)/latex all-pdf
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
text:
|
||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||
@echo
|
||||
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||
|
||||
man:
|
||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
@echo
|
||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||
|
||||
changes:
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||
|
||||
linkcheck:
|
||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||
@echo
|
||||
@echo "Link check complete; look for any errors in the above output " \
|
||||
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||
|
||||
doctest:
|
||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||
@echo "Testing of doctests in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/doctest/output.txt."
|
BIN
docs/build/doctrees/CSS-styles.doctree
vendored
Normal file
BIN
docs/build/doctrees/HTML-snippets.doctree
vendored
Normal file
BIN
docs/build/doctrees/api/ajax.doctree
vendored
Normal file
BIN
docs/build/doctrees/api/callback.doctree
vendored
Normal file
BIN
docs/build/doctrees/api/elementjax.doctree
vendored
Normal file
BIN
docs/build/doctrees/api/html.doctree
vendored
Normal file
BIN
docs/build/doctrees/api/hub.doctree
vendored
Normal file
BIN
docs/build/doctrees/api/index.doctree
vendored
Normal file
BIN
docs/build/doctrees/api/inputjax.doctree
vendored
Normal file
BIN
docs/build/doctrees/api/jax.doctree
vendored
Normal file
BIN
docs/build/doctrees/api/message.doctree
vendored
Normal file
BIN
docs/build/doctrees/api/object.doctree
vendored
Normal file
BIN
docs/build/doctrees/api/outputjax.doctree
vendored
Normal file
BIN
docs/build/doctrees/api/queue.doctree
vendored
Normal file
BIN
docs/build/doctrees/api/signal.doctree
vendored
Normal file
BIN
docs/build/doctrees/api/variable.doctree
vendored
Normal file
BIN
docs/build/doctrees/callbacks.doctree
vendored
Normal file
BIN
docs/build/doctrees/community.doctree
vendored
Normal file
BIN
docs/build/doctrees/configuration.doctree
vendored
Normal file
BIN
docs/build/doctrees/dynamic.doctree
vendored
Normal file
BIN
docs/build/doctrees/environment.pickle
vendored
Normal file
BIN
docs/build/doctrees/glossary.doctree
vendored
Normal file
BIN
docs/build/doctrees/index.doctree
vendored
Normal file
BIN
docs/build/doctrees/installation.doctree
vendored
Normal file
BIN
docs/build/doctrees/jsMath.doctree
vendored
Normal file
BIN
docs/build/doctrees/mathjax.doctree
vendored
Normal file
BIN
docs/build/doctrees/mathml.doctree
vendored
Normal file
BIN
docs/build/doctrees/model.doctree
vendored
Normal file
BIN
docs/build/doctrees/options/FontWarnings.doctree
vendored
Normal file
BIN
docs/build/doctrees/options/HTML-CSS.doctree
vendored
Normal file
BIN
docs/build/doctrees/options/MMLorHTML.doctree
vendored
Normal file
BIN
docs/build/doctrees/options/MathML.doctree
vendored
Normal file
BIN
docs/build/doctrees/options/MathMenu.doctree
vendored
Normal file
BIN
docs/build/doctrees/options/MathZoom.doctree
vendored
Normal file
BIN
docs/build/doctrees/options/NativeMML.doctree
vendored
Normal file
BIN
docs/build/doctrees/options/TeX.doctree
vendored
Normal file
BIN
docs/build/doctrees/options/hub.doctree
vendored
Normal file
BIN
docs/build/doctrees/options/jsMath2jax.doctree
vendored
Normal file
BIN
docs/build/doctrees/options/mml2jax.doctree
vendored
Normal file
BIN
docs/build/doctrees/options/tex2jax.doctree
vendored
Normal file
BIN
docs/build/doctrees/output.doctree
vendored
Normal file
BIN
docs/build/doctrees/platforms/index.doctree
vendored
Normal file
BIN
docs/build/doctrees/platforms/movable-type.doctree
vendored
Normal file
BIN
docs/build/doctrees/platforms/wordpress.doctree
vendored
Normal file
BIN
docs/build/doctrees/queues.doctree
vendored
Normal file
BIN
docs/build/doctrees/signals.doctree
vendored
Normal file
BIN
docs/build/doctrees/start.doctree
vendored
Normal file
BIN
docs/build/doctrees/startup.doctree
vendored
Normal file
BIN
docs/build/doctrees/synchronize.doctree
vendored
Normal file
BIN
docs/build/doctrees/tex.doctree
vendored
Normal file
BIN
docs/build/doctrees/typeset.doctree
vendored
Normal file
4
docs/build/html/.buildinfo
vendored
Normal file
|
@ -0,0 +1,4 @@
|
|||
# Sphinx build info version 1
|
||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||
config: de13b3a14e25f3f8568ad784a71d7679
|
||||
tags: fbb0d17656682115ca4d033fb2f83ba1
|
|
@ -21,11 +21,64 @@
|
|||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="../../MathJax.js"></script>
|
||||
<link rel="top" title="MathJax v1.1 documentation" href="index.html" />
|
||||
<link rel="next" title="Glossary" href="glossary.html" />
|
||||
<link rel="prev" title="Describing HTML snippets" href="HTML-snippets.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
<div id="header">
|
||||
<div id="branding" role="banner">
|
||||
<h1 id="site-title">
|
||||
<span>
|
||||
<a href="http://www.mathjax.org/" title="MathJax" rel="home">
|
||||
<img src="_static/logo.gif" alt="MathJax">
|
||||
</a>
|
||||
</span>
|
||||
</h1>
|
||||
|
||||
<div id="site-description">Beautiful math in all browsers</div>
|
||||
<div class="clear"></div>
|
||||
|
||||
<div id="access" role="navigation">
|
||||
<div class="menu-header">
|
||||
<ul id="menu-navigation" class="menu">
|
||||
<li id="menu-item-868" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/news/">News</a></li>
|
||||
<li id="menu-item-846" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/demos/">Demos</a>
|
||||
<ul class="sub-menu">
|
||||
<li id="menu-item-859" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/demos/tex-samples/">TeX Samples</a></li>
|
||||
<li id="menu-item-858" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/demos/mathml-samples/">MathML Samples</a></li>
|
||||
<li id="menu-item-1078" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/demos/scaling-math/">Scaling Math</a></li>
|
||||
<li id="menu-item-1097" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/demos/copy-and-paste/">Copy and Paste Math</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li id="menu-item-848" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/resources/">Resources</a>
|
||||
<ul class="sub-menu">
|
||||
<li id="menu-item-1262" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/download/">Download</a></li>
|
||||
<li id="menu-item-1151" class="menu-item menu-item-type-custom"><a href="/resources/docs/">Documentation</a></li>
|
||||
<li id="menu-item-1257" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/resources/articles-and-presentations/">Articles, Presentations, and Tutorials</a></li>
|
||||
<li id="menu-item-860" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/resources/browser-compatibility/">Browser Compatibility</a></li>
|
||||
<li id="menu-item-856" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/resources/faqs/">FAQs</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li id="menu-item-847" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/community/">Community</a>
|
||||
<ul class="sub-menu">
|
||||
<li id="menu-item-1347" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/community/mathjax-badge/">MathJax Badge</a></li>
|
||||
<li id="menu-item-1145" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/community/mathjax-in-use/">MathJax in Use</a></li>
|
||||
<li id="menu-item-1577" class="menu-item menu-item-type-custom"><a href="http://groups.google.com/group/mathjax-users/">MathJax User Group</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li id="menu-item-853" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/sponsors/">Sponsors</a></li>
|
||||
<li id="menu-item-854" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/contact/">Contact</a></li>
|
||||
<li id="menu-item-1167" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/download/">Download</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clear"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
|
@ -166,8 +219,9 @@ samples. In particular, the <tt class="docutils literal"><span class="pre">exte
|
|||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2010 Design Science.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.4.
|
||||
© Copyright 2011 Design Science.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
|
@ -21,11 +21,64 @@
|
|||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="../../MathJax.js"></script>
|
||||
<link rel="top" title="MathJax v1.1 documentation" href="index.html" />
|
||||
<link rel="next" title="CSS Style Objects" href="CSS-styles.html" />
|
||||
<link rel="prev" title="Converting to MathJax from jsMath" href="jsMath.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
<div id="header">
|
||||
<div id="branding" role="banner">
|
||||
<h1 id="site-title">
|
||||
<span>
|
||||
<a href="http://www.mathjax.org/" title="MathJax" rel="home">
|
||||
<img src="_static/logo.gif" alt="MathJax">
|
||||
</a>
|
||||
</span>
|
||||
</h1>
|
||||
|
||||
<div id="site-description">Beautiful math in all browsers</div>
|
||||
<div class="clear"></div>
|
||||
|
||||
<div id="access" role="navigation">
|
||||
<div class="menu-header">
|
||||
<ul id="menu-navigation" class="menu">
|
||||
<li id="menu-item-868" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/news/">News</a></li>
|
||||
<li id="menu-item-846" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/demos/">Demos</a>
|
||||
<ul class="sub-menu">
|
||||
<li id="menu-item-859" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/demos/tex-samples/">TeX Samples</a></li>
|
||||
<li id="menu-item-858" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/demos/mathml-samples/">MathML Samples</a></li>
|
||||
<li id="menu-item-1078" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/demos/scaling-math/">Scaling Math</a></li>
|
||||
<li id="menu-item-1097" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/demos/copy-and-paste/">Copy and Paste Math</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li id="menu-item-848" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/resources/">Resources</a>
|
||||
<ul class="sub-menu">
|
||||
<li id="menu-item-1262" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/download/">Download</a></li>
|
||||
<li id="menu-item-1151" class="menu-item menu-item-type-custom"><a href="/resources/docs/">Documentation</a></li>
|
||||
<li id="menu-item-1257" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/resources/articles-and-presentations/">Articles, Presentations, and Tutorials</a></li>
|
||||
<li id="menu-item-860" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/resources/browser-compatibility/">Browser Compatibility</a></li>
|
||||
<li id="menu-item-856" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/resources/faqs/">FAQs</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li id="menu-item-847" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/community/">Community</a>
|
||||
<ul class="sub-menu">
|
||||
<li id="menu-item-1347" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/community/mathjax-badge/">MathJax Badge</a></li>
|
||||
<li id="menu-item-1145" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/community/mathjax-in-use/">MathJax in Use</a></li>
|
||||
<li id="menu-item-1577" class="menu-item menu-item-type-custom"><a href="http://groups.google.com/group/mathjax-users/">MathJax User Group</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li id="menu-item-853" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/sponsors/">Sponsors</a></li>
|
||||
<li id="menu-item-854" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/contact/">Contact</a></li>
|
||||
<li id="menu-item-1167" class="menu-item menu-item-type-post_type"><a href="http://www.mathjax.org/download/">Download</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clear"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
|
@ -163,8 +216,9 @@ This is bold text shown in red
|
|||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2010 Design Science.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.4.
|
||||
© Copyright 2011 Design Science.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 28 KiB |
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
Before Width: | Height: | Size: 7.1 KiB After Width: | Height: | Size: 7.1 KiB |
Before Width: | Height: | Size: 6.9 KiB After Width: | Height: | Size: 6.9 KiB |