Skip to content

Commit 4fc12a0

Browse files
ammsaammsa
committed
Add documentation
1 parent 152354d commit 4fc12a0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+16581
-13
lines changed

‎.gitignore

-4
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ __pycache__/
3737
# Distribution / packaging
3838
.Python
3939
env/
40-
build/
4140
develop-eggs/
4241
dist/
4342
downloads/
@@ -76,9 +75,6 @@ coverage.xml
7675
# Django stuff:
7776
*.log
7877

79-
# Sphinx documentation
80-
docs/_build/
81-
8278
# PyBuilder
8379
target/
8480

‎README.rst

+13-9
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,15 @@ installation
1212
Quick start
1313
-----------
1414

15-
1. Add "latexify" to your INSTALLED_APPS setting like this::
15+
1. Add "latexify" to your INSTALLED_APPS setting like this:
1616

17-
INSTALLED_APPS = (
18-
...
19-
'latexify',
20-
)
17+
.. code-block:: python
2118
19+
INSTALLED_APPS = (
20+
...
21+
'latexify',
22+
...
23+
)
2224
2325
2. In your template, load latexify by including::
2426

@@ -35,10 +37,12 @@ Quick start
3537

3638
5. Latexify your text by including the template tag, for example
3739

38-
{% latexify context_arg %}
39-
{% latexify context_arg parse_math=True %}
40-
{% latexify 'c = \pm\sqrt{a^2 + b^2}' math_inline=True %}
41-
{% latexify 'c = \pm\sqrt{a^2 + b^2}' math_block=True %}
40+
.. code-block:: html
41+
42+
{% latexify context_arg %}
43+
{% latexify context_arg parse_math=True %}
44+
{% latexify 'c = \pm\sqrt{a^2 + b^2}' math_inline=True %}
45+
{% latexify 'c = \pm\sqrt{a^2 + b^2}' math_block=True %}
4246

4347

4448

‎docs/Makefile

+225
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,225 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
PAPER =
8+
BUILDDIR = build
9+
10+
# Internal variables.
11+
PAPEROPT_a4 = -D latex_paper_size=a4
12+
PAPEROPT_letter = -D latex_paper_size=letter
13+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
14+
# the i18n builder cannot share the environment and doctrees with the others
15+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
16+
17+
.PHONY: help
18+
help:
19+
@echo "Please use \`make <target>' where <target> is one of"
20+
@echo " html to make standalone HTML files"
21+
@echo " dirhtml to make HTML files named index.html in directories"
22+
@echo " singlehtml to make a single large HTML file"
23+
@echo " pickle to make pickle files"
24+
@echo " json to make JSON files"
25+
@echo " htmlhelp to make HTML files and a HTML help project"
26+
@echo " qthelp to make HTML files and a qthelp project"
27+
@echo " applehelp to make an Apple Help Book"
28+
@echo " devhelp to make HTML files and a Devhelp project"
29+
@echo " epub to make an epub"
30+
@echo " epub3 to make an epub3"
31+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
32+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
33+
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
34+
@echo " text to make text files"
35+
@echo " man to make manual pages"
36+
@echo " texinfo to make Texinfo files"
37+
@echo " info to make Texinfo files and run them through makeinfo"
38+
@echo " gettext to make PO message catalogs"
39+
@echo " changes to make an overview of all changed/added/deprecated items"
40+
@echo " xml to make Docutils-native XML files"
41+
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
42+
@echo " linkcheck to check all external links for integrity"
43+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
44+
@echo " coverage to run coverage check of the documentation (if enabled)"
45+
@echo " dummy to check syntax errors of document sources"
46+
47+
.PHONY: clean
48+
clean:
49+
rm -rf $(BUILDDIR)/*
50+
51+
.PHONY: html
52+
html:
53+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
54+
@echo
55+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
56+
57+
.PHONY: dirhtml
58+
dirhtml:
59+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
60+
@echo
61+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
62+
63+
.PHONY: singlehtml
64+
singlehtml:
65+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
66+
@echo
67+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
68+
69+
.PHONY: pickle
70+
pickle:
71+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
72+
@echo
73+
@echo "Build finished; now you can process the pickle files."
74+
75+
.PHONY: json
76+
json:
77+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
78+
@echo
79+
@echo "Build finished; now you can process the JSON files."
80+
81+
.PHONY: htmlhelp
82+
htmlhelp:
83+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
84+
@echo
85+
@echo "Build finished; now you can run HTML Help Workshop with the" \
86+
".hhp project file in $(BUILDDIR)/htmlhelp."
87+
88+
.PHONY: qthelp
89+
qthelp:
90+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
91+
@echo
92+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
93+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
94+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/django-latexify.qhcp"
95+
@echo "To view the help file:"
96+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-latexify.qhc"
97+
98+
.PHONY: applehelp
99+
applehelp:
100+
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
101+
@echo
102+
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
103+
@echo "N.B. You won't be able to view it unless you put it in" \
104+
"~/Library/Documentation/Help or install it in your application" \
105+
"bundle."
106+
107+
.PHONY: devhelp
108+
devhelp:
109+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
110+
@echo
111+
@echo "Build finished."
112+
@echo "To view the help file:"
113+
@echo "# mkdir -p $$HOME/.local/share/devhelp/django-latexify"
114+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django-latexify"
115+
@echo "# devhelp"
116+
117+
.PHONY: epub
118+
epub:
119+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
120+
@echo
121+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
122+
123+
.PHONY: epub3
124+
epub3:
125+
$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
126+
@echo
127+
@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
128+
129+
.PHONY: latex
130+
latex:
131+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
132+
@echo
133+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
134+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
135+
"(use \`make latexpdf' here to do that automatically)."
136+
137+
.PHONY: latexpdf
138+
latexpdf:
139+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
140+
@echo "Running LaTeX files through pdflatex..."
141+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
142+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
143+
144+
.PHONY: latexpdfja
145+
latexpdfja:
146+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
147+
@echo "Running LaTeX files through platex and dvipdfmx..."
148+
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
149+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
150+
151+
.PHONY: text
152+
text:
153+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
154+
@echo
155+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
156+
157+
.PHONY: man
158+
man:
159+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
160+
@echo
161+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
162+
163+
.PHONY: texinfo
164+
texinfo:
165+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
166+
@echo
167+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
168+
@echo "Run \`make' in that directory to run these through makeinfo" \
169+
"(use \`make info' here to do that automatically)."
170+
171+
.PHONY: info
172+
info:
173+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
174+
@echo "Running Texinfo files through makeinfo..."
175+
make -C $(BUILDDIR)/texinfo info
176+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
177+
178+
.PHONY: gettext
179+
gettext:
180+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
181+
@echo
182+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
183+
184+
.PHONY: changes
185+
changes:
186+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
187+
@echo
188+
@echo "The overview file is in $(BUILDDIR)/changes."
189+
190+
.PHONY: linkcheck
191+
linkcheck:
192+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
193+
@echo
194+
@echo "Link check complete; look for any errors in the above output " \
195+
"or in $(BUILDDIR)/linkcheck/output.txt."
196+
197+
.PHONY: doctest
198+
doctest:
199+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
200+
@echo "Testing of doctests in the sources finished, look at the " \
201+
"results in $(BUILDDIR)/doctest/output.txt."
202+
203+
.PHONY: coverage
204+
coverage:
205+
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
206+
@echo "Testing of coverage in the sources finished, look at the " \
207+
"results in $(BUILDDIR)/coverage/python.txt."
208+
209+
.PHONY: xml
210+
xml:
211+
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
212+
@echo
213+
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
214+
215+
.PHONY: pseudoxml
216+
pseudoxml:
217+
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
218+
@echo
219+
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
220+
221+
.PHONY: dummy
222+
dummy:
223+
$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
224+
@echo
225+
@echo "Build finished. Dummy builder generates no files."

‎docs/build/doctrees/environment.pickle

8.47 KB
Binary file not shown.

‎docs/build/doctrees/example.doctree

5.58 KB
Binary file not shown.

‎docs/build/doctrees/help.doctree

2.9 KB
Binary file not shown.

‎docs/build/doctrees/index.doctree

19.8 KB
Binary file not shown.

‎docs/build/doctrees/license.doctree

5.53 KB
Binary file not shown.

‎docs/build/doctrees/settings.doctree

3.77 KB
Binary file not shown.

‎docs/build/html/.buildinfo

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: dca1f7870db1c3207a3546be07707fe9
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/build/html/.nojekyll

Whitespace-only changes.

‎docs/build/html/_sources/example.txt

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
Usage
2+
-----
3+
4+
Examples
5+
========
6+
7+
8+
9+
Bellow is a full example:
10+
11+
This is just a simple view that will include `my_mathy_paragraph` variable to be included in the context passed to the template
12+
13+
.. code-block:: python
14+
15+
# views.py
16+
from django.views.generic.base import TemplateView
17+
from somewhere import my_mathy_paragraph
18+
19+
class HomePageView(TemplateView):
20+
template_name = "home.html"
21+
22+
def get_context_data(self, **kwargs):
23+
context = super(HomePageView, self).get_context_data(**kwargs)
24+
context['my_mathy_paragraph'] = my_mathy_paragraph
25+
return context
26+
27+
28+
In the HTML that will use django-latexify
29+
30+
.. code-block:: html
31+
32+
{% load staticfiles %}
33+
{% load latexify %}
34+
35+
<!DOCTYPE html>
36+
<html lang="en">
37+
<head>
38+
<meta charset="UTF-8">
39+
<title>My math blog</title>
40+
{% include 'latexify/stylesheets.html' %}
41+
</head>
42+
43+
<body>
44+
<h2>Welcome to my mathy blog</h2>
45+
46+
<p>{% latixfy my_mathy_paragraph parse_math=True %}</p>
47+
48+
<p>{% latixfy 'My latex like plain text'%}</p>
49+
50+
<p>My inline math {% latixfy 'e=mc^2' inline_math=True %}</p>
51+
52+
<p>My block math {% latixfy 'e=mc^2' block_math=True %}</p>
53+
54+
55+
{% include "latexify/scripts.html" %}
56+
</body>
57+
</html>
58+

‎docs/build/html/_sources/help.txt

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Need Help?
2+
==========
3+
4+
If you're having trouble, please email [email protected], or create a github issue.

0 commit comments

Comments
 (0)