aafshar / pida-main
The main PIDA branch
Clone this repository (size: 4.7 MB): HTTPS / SSH
$ hg clone http://bitbucket.org/aafshar/pida-main/
| commit 2033: | 7406797adf3a |
| parent 2032: | 54409423eb91 |
| branch: | default |
Updated Makefile + conf.py for Sphinx/Python2.6 build bug. Builds correctly now.
Changed (Δ806 bytes):
raw changeset »
docs/Makefile (33 lines added, 15 lines removed)
docs/source/conf.py (2 lines added, 1 lines removed)
docs/source/user/installation.rst (0 lines added, 1 lines removed)
Up to file-list docs/Makefile:
| … | … | @@ -11,45 +11,60 @@ PAPEROPT_a4 = -D latex_paper_size=a4 |
11 |
11 |
PAPEROPT_letter = -D latex_paper_size=letter |
12 |
12 |
ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source |
13 |
13 |
|
14 |
.PHONY: help clean html |
|
14 |
.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest |
|
15 |
15 |
|
16 |
16 |
help: |
17 |
17 |
@echo "Please use \`make <target>' where <target> is one of" |
18 |
18 |
@echo " html to make standalone HTML files" |
19 |
@echo " |
|
19 |
@echo " dirhtml to make HTML files named index.html in directories" |
|
20 |
@echo " pickle to make pickle files" |
|
21 |
@echo " json to make JSON files" |
|
20 |
22 |
@echo " htmlhelp to make HTML files and a HTML help project" |
23 |
@echo " qthelp to make HTML files and a qthelp project" |
|
21 |
24 |
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" |
22 |
@echo " changes to make an overview o |
|
25 |
@echo " changes to make an overview of all changed/added/deprecated items" |
|
23 |
26 |
@echo " linkcheck to check all external links for integrity" |
27 |
@echo " doctest to run all doctests embedded in the documentation (if enabled)" |
|
24 |
28 |
|
25 |
29 |
clean: |
26 |
30 |
-rm -rf _build/* |
27 |
31 |
|
28 |
32 |
html: |
29 |
mkdir -p _build/html _build/doctrees |
|
30 |
33 |
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html |
31 |
34 |
@echo |
32 |
@echo "Build finished. The HTML pages are in |
|
35 |
@echo "Build finished. The HTML pages are in _build/html." |
|
36 |
||
37 |
dirhtml: |
|
38 |
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml |
|
39 |
@echo |
|
40 |
@echo "Build finished. The HTML pages are in _build/dirhtml." |
|
33 |
41 |
|
34 |
42 |
pickle: |
35 |
mkdir -p _build/pickle _build/doctrees |
|
36 |
43 |
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle |
37 |
44 |
@echo |
38 |
@echo "Build finished; now you can process the pickle files or run" |
|
39 |
@echo " sphinx-web _build/pickle" |
|
40 |
@echo " |
|
45 |
@echo "Build finished; now you can process the pickle files." |
|
41 |
46 |
|
42 |
web: pickle |
|
47 |
json: |
|
48 |
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json |
|
49 |
@echo |
|
50 |
@echo "Build finished; now you can process the JSON files." |
|
43 |
51 |
|
44 |
52 |
htmlhelp: |
45 |
mkdir -p _build/htmlhelp _build/doctrees |
|
46 |
53 |
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp |
47 |
54 |
@echo |
48 |
55 |
@echo "Build finished; now you can run HTML Help Workshop with the" \ |
49 |
".hhp project file in |
|
56 |
".hhp project file in _build/htmlhelp." |
|
57 |
||
58 |
qthelp: |
|
59 |
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp |
|
60 |
@echo |
|
61 |
@echo "Build finished; now you can run "qcollectiongenerator" with the" \ |
|
62 |
".qhcp project file in _build/qthelp, like this:" |
|
63 |
@echo "# qcollectiongenerator _build/qthelp/PIDA Documentation.qhcp" |
|
64 |
@echo "To view the help file:" |
|
65 |
@echo "# assistant -collectionFile _build/qthelp/PIDA Documentation.qhc" |
|
50 |
66 |
|
51 |
67 |
latex: |
52 |
mkdir -p _build/latex _build/doctrees |
|
53 |
68 |
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex |
54 |
69 |
@echo |
55 |
70 |
@echo "Build finished; the LaTeX files are in _build/latex." |
| … | … | @@ -57,14 +72,17 @@ latex: |
57 |
72 |
"run these through (pdf)latex." |
58 |
73 |
|
59 |
74 |
changes: |
60 |
mkdir -p _build/changes _build/doctrees |
|
61 |
75 |
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes |
62 |
76 |
@echo |
63 |
77 |
@echo "The overview file is in _build/changes." |
64 |
78 |
|
65 |
79 |
linkcheck: |
66 |
mkdir -p _build/linkcheck _build/doctrees |
|
67 |
80 |
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck |
68 |
81 |
@echo |
69 |
82 |
@echo "Link check complete; look for any errors in the above output " \ |
70 |
83 |
"or in _build/linkcheck/output.txt." |
84 |
||
85 |
doctest: |
|
86 |
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest |
|
87 |
@echo "Testing of doctests in the sources finished, look at the " \ |
|
88 |
"results in _build/doctest/output.txt." |
Up to file-list docs/source/conf.py:
| … | … | @@ -8,7 +8,8 @@ import sys, os |
8 |
8 |
|
9 |
9 |
# Add any Sphinx extension module names here, as strings. They can be extensions |
10 |
10 |
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
11 |
|
|
11 |
#extensions = ['sphinx.ext.autodoc'] |
|
12 |
extensions = [] |
|
12 |
13 |
|
13 |
14 |
# Add any paths that contain templates here, relative to this directory. |
14 |
15 |
templates_path = ['_templates'] |