Moved documentation source to separate directory and rename build directory to
match the name used in newer versions of Sphinx.
This commit is contained in:
parent
7299d41eca
commit
dceea89925
2
.gitignore
vendored
2
.gitignore
vendored
@ -1,6 +1,6 @@
|
||||
*.pyc
|
||||
build/
|
||||
dist/
|
||||
doc/.build
|
||||
doc/build
|
||||
cx_Oracle.egg-info/
|
||||
MANIFEST
|
||||
|
||||
41
doc/Makefile
41
doc/Makefile
@ -5,11 +5,12 @@
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
PAPER =
|
||||
BUILD_DIR = build
|
||||
|
||||
# Internal variables.
|
||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||
PAPEROPT_letter = -D latex_paper_size=letter
|
||||
ALLSPHINXOPTS = -d .build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||
ALLSPHINXOPTS = -d $(BUILD_DIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) src
|
||||
|
||||
.PHONY: help clean html web htmlhelp latex changes linkcheck
|
||||
|
||||
@ -23,46 +24,46 @@ help:
|
||||
@echo " linkcheck to check all external links for integrity"
|
||||
|
||||
clean:
|
||||
-rm -rf .build/*
|
||||
-rm -rf $(BUILD_DIR)
|
||||
|
||||
html:
|
||||
mkdir -p .build/doctrees
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) .build/html
|
||||
mkdir -p $(BUILD_DIR)/doctrees
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILD_DIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in .build/html"
|
||||
@echo "Build finished. The HTML pages are in $(BUILD_DIR)/html"
|
||||
|
||||
web:
|
||||
mkdir -p .build/web .build/doctrees
|
||||
$(SPHINXBUILD) -b web $(ALLSPHINXOPTS) .build/web
|
||||
mkdir -p $(BUILD_DIR)/web $(BUILD_DIR)/doctrees
|
||||
$(SPHINXBUILD) -b web $(ALLSPHINXOPTS) $(BUILD_DIR)/web
|
||||
@echo
|
||||
@echo "Build finished; now you can run"
|
||||
@echo " python -m sphinx.web .build/web"
|
||||
@echo " python -m sphinx.web $(BUILD_DIR)/web"
|
||||
@echo "to start the server."
|
||||
|
||||
htmlhelp:
|
||||
mkdir -p .build/htmlhelp .build/doctrees
|
||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) .build/htmlhelp
|
||||
mkdir -p $(BUILD_DIR)/htmlhelp $(BUILD_DIR)/doctrees
|
||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILD_DIR)/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_DIR)/htmlhelp."
|
||||
|
||||
latex:
|
||||
mkdir -p .build/latex .build/doctrees
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) .build/latex
|
||||
mkdir -p $(BUILD_DIR)/latex $(BUILD_DIR)/doctrees
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILD_DIR)/latex
|
||||
@echo
|
||||
@echo "Build finished; the LaTeX files are in .build/latex."
|
||||
@echo "Build finished; the LaTeX files are in $(BUILD_DIR)/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_DIR)/changes $(BUILD_DIR)/doctrees
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILD_DIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in .build/changes."
|
||||
@echo "The overview file is in $(BUILD_DIR)/changes."
|
||||
|
||||
linkcheck:
|
||||
mkdir -p .build/linkcheck .build/doctrees
|
||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) .build/linkcheck
|
||||
mkdir -p $(BUILD_DIR)/linkcheck $(BUILD_DIR)/doctrees
|
||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILD_DIR)/linkcheck
|
||||
@echo
|
||||
@echo "Link check complete; look for any errors in the above output " \
|
||||
"or in .build/linkcheck/output.txt."
|
||||
"or in $(BUILD_DIR)/linkcheck/output.txt."
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user