mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Use Windows-friendlier dirnames.
This commit is contained in:
parent
94a868db40
commit
5f78bc436b
44
doc/Makefile
44
doc/Makefile
@ -6,7 +6,7 @@ SPHINXOPTS =
|
|||||||
SPHINXBUILD = python ../sphinx-build.py
|
SPHINXBUILD = python ../sphinx-build.py
|
||||||
PAPER =
|
PAPER =
|
||||||
|
|
||||||
ALLSPHINXOPTS = -d .build/doctrees -D latex_paper_size=$(PAPER) \
|
ALLSPHINXOPTS = -d _build/doctrees -D latex_paper_size=$(PAPER) \
|
||||||
$(SPHINXOPTS) .
|
$(SPHINXOPTS) .
|
||||||
|
|
||||||
.PHONY: help clean html web htmlhelp latex changes linkcheck
|
.PHONY: help clean html web htmlhelp latex changes linkcheck
|
||||||
@ -21,50 +21,50 @@ help:
|
|||||||
@echo " linkcheck to check all external links for integrity"
|
@echo " linkcheck to check all external links for integrity"
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
-rm -rf .build/*
|
-rm -rf _build/*
|
||||||
|
|
||||||
html:
|
html:
|
||||||
mkdir -p .build/html .build/doctrees
|
mkdir -p _build/html _build/doctrees
|
||||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) .build/html
|
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
|
||||||
@echo
|
@echo
|
||||||
@echo "Build finished. The HTML pages are in .build/html."
|
@echo "Build finished. The HTML pages are in _build/html."
|
||||||
|
|
||||||
web:
|
web:
|
||||||
mkdir -p .build/web .build/doctrees
|
mkdir -p _build/web _build/doctrees
|
||||||
$(SPHINXBUILD) -b web $(ALLSPHINXOPTS) .build/web
|
$(SPHINXBUILD) -b web $(ALLSPHINXOPTS) _build/web
|
||||||
@echo
|
@echo
|
||||||
@echo "Build finished; now you can run"
|
@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."
|
@echo "to start the server."
|
||||||
|
|
||||||
htmlhelp:
|
htmlhelp:
|
||||||
mkdir -p .build/htmlhelp .build/doctrees
|
mkdir -p _build/htmlhelp _build/doctrees
|
||||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) .build/htmlhelp
|
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
|
||||||
@echo
|
@echo
|
||||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
@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:
|
latex:
|
||||||
mkdir -p .build/latex .build/doctrees
|
mkdir -p _build/latex _build/doctrees
|
||||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) .build/latex
|
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
|
||||||
@echo
|
@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" \
|
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
|
||||||
"run these through (pdf)latex."
|
"run these through (pdf)latex."
|
||||||
|
|
||||||
changes:
|
changes:
|
||||||
mkdir -p .build/changes .build/doctrees
|
mkdir -p _build/changes _build/doctrees
|
||||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) .build/changes
|
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
|
||||||
@echo
|
@echo
|
||||||
@echo "The overview file is in .build/changes."
|
@echo "The overview file is in _build/changes."
|
||||||
|
|
||||||
linkcheck:
|
linkcheck:
|
||||||
mkdir -p .build/linkcheck .build/doctrees
|
mkdir -p _build/linkcheck _build/doctrees
|
||||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) .build/linkcheck
|
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
|
||||||
@echo
|
@echo
|
||||||
@echo "Link check complete; look for any errors in the above output " \
|
@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:
|
doctest:
|
||||||
mkdir -p .build/doctest .build/doctrees
|
mkdir -p _build/doctest _build/doctrees
|
||||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) .build/doctest
|
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest
|
||||||
|
Before Width: | Height: | Size: 33 KiB After Width: | Height: | Size: 33 KiB |
@ -24,7 +24,7 @@ sys.path.append(os.path.dirname(__file__))
|
|||||||
extensions = ['ext', 'sphinx.ext.autodoc', 'sphinx.ext.doctest']
|
extensions = ['ext', 'sphinx.ext.autodoc', 'sphinx.ext.doctest']
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
templates_path = ['.templates']
|
templates_path = ['_templates']
|
||||||
|
|
||||||
# The suffix of source filenames.
|
# The suffix of source filenames.
|
||||||
source_suffix = '.rst'
|
source_suffix = '.rst'
|
||||||
@ -77,7 +77,7 @@ html_style = 'sphinxdoc.css'
|
|||||||
# Add any paths that contain custom static files (such as style sheets) here,
|
# 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,
|
# relative to this directory. They are copied after the builtin static files,
|
||||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
# 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,
|
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||||
# using the given strftime format.
|
# using the given strftime format.
|
||||||
|
Loading…
Reference in New Issue
Block a user