diff options
| -rw-r--r-- | doc/Makefile | 44 | ||||
| -rw-r--r-- | doc/_static/sphinx.png (renamed from doc/.static/sphinx.png) | bin | 34160 -> 34160 bytes | |||
| -rw-r--r-- | doc/_templates/index.html (renamed from doc/.templates/index.html) | 0 | ||||
| -rw-r--r-- | doc/_templates/indexsidebar.html (renamed from doc/.templates/indexsidebar.html) | 0 | ||||
| -rw-r--r-- | doc/_templates/layout.html (renamed from doc/.templates/layout.html) | 0 | ||||
| -rw-r--r-- | doc/conf.py | 4 |
6 files changed, 24 insertions, 24 deletions
diff --git a/doc/Makefile b/doc/Makefile index 44b698ca0..2622cb85b 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -6,7 +6,7 @@ SPHINXOPTS = SPHINXBUILD = python ../sphinx-build.py PAPER = -ALLSPHINXOPTS = -d .build/doctrees -D latex_paper_size=$(PAPER) \ +ALLSPHINXOPTS = -d _build/doctrees -D latex_paper_size=$(PAPER) \ $(SPHINXOPTS) . .PHONY: help clean html web htmlhelp latex changes linkcheck @@ -21,50 +21,50 @@ help: @echo " linkcheck to check all external links for integrity" clean: - -rm -rf .build/* + -rm -rf _build/* html: - mkdir -p .build/html .build/doctrees - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) .build/html + mkdir -p _build/html _build/doctrees + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html @echo - @echo "Build finished. The HTML pages are in .build/html." + @echo "Build finished. The HTML pages are in _build/html." web: - mkdir -p .build/web .build/doctrees - $(SPHINXBUILD) -b web $(ALLSPHINXOPTS) .build/web + mkdir -p _build/web _build/doctrees + $(SPHINXBUILD) -b web $(ALLSPHINXOPTS) _build/web @echo @echo "Build finished; now you can run" - @echo " python -m sphinx.web .build/web" + @echo " python -m sphinx.web _build/web" @echo "to start the server." htmlhelp: - mkdir -p .build/htmlhelp .build/doctrees - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) .build/htmlhelp + mkdir -p _build/htmlhelp _build/doctrees + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in .build/htmlhelp." + ".hhp project file in _build/htmlhelp." latex: - mkdir -p .build/latex .build/doctrees - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) .build/latex + mkdir -p _build/latex _build/doctrees + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex @echo - @echo "Build finished; the LaTeX files are in .build/latex." + @echo "Build finished; the LaTeX files are in _build/latex." @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ "run these through (pdf)latex." changes: - mkdir -p .build/changes .build/doctrees - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) .build/changes + mkdir -p _build/changes _build/doctrees + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes @echo - @echo "The overview file is in .build/changes." + @echo "The overview file is in _build/changes." linkcheck: - mkdir -p .build/linkcheck .build/doctrees - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) .build/linkcheck + mkdir -p _build/linkcheck _build/doctrees + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ - "or in .build/linkcheck/output.txt." + "or in _build/linkcheck/output.txt." doctest: - mkdir -p .build/doctest .build/doctrees - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) .build/doctest + mkdir -p _build/doctest _build/doctrees + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest diff --git a/doc/.static/sphinx.png b/doc/_static/sphinx.png Binary files differindex 85ac6d92b..85ac6d92b 100644 --- a/doc/.static/sphinx.png +++ b/doc/_static/sphinx.png diff --git a/doc/.templates/index.html b/doc/_templates/index.html index e0b15cd8b..e0b15cd8b 100644 --- a/doc/.templates/index.html +++ b/doc/_templates/index.html diff --git a/doc/.templates/indexsidebar.html b/doc/_templates/indexsidebar.html index 5fcddad6d..5fcddad6d 100644 --- a/doc/.templates/indexsidebar.html +++ b/doc/_templates/indexsidebar.html diff --git a/doc/.templates/layout.html b/doc/_templates/layout.html index 3a819dce2..3a819dce2 100644 --- a/doc/.templates/layout.html +++ b/doc/_templates/layout.html diff --git a/doc/conf.py b/doc/conf.py index 717299e23..8f282cc0d 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -24,7 +24,7 @@ sys.path.append(os.path.dirname(__file__)) extensions = ['ext', 'sphinx.ext.autodoc', 'sphinx.ext.doctest'] # Add any paths that contain templates here, relative to this directory. -templates_path = ['.templates'] +templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' @@ -77,7 +77,7 @@ html_style = 'sphinxdoc.css' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['.static'] +html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. |
