Skip to content

Commit dceea89

Browse files
Moved documentation source to separate directory and rename build directory to
match the name used in newer versions of Sphinx.
1 parent 7299d41 commit dceea89

15 files changed

+22
-21
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
*.pyc
22
build/
33
dist/
4-
doc/.build
4+
doc/build
55
cx_Oracle.egg-info/
66
MANIFEST

doc/Makefile

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@
55
SPHINXOPTS =
66
SPHINXBUILD = sphinx-build
77
PAPER =
8+
BUILD_DIR = build
89

910
# Internal variables.
1011
PAPEROPT_a4 = -D latex_paper_size=a4
1112
PAPEROPT_letter = -D latex_paper_size=letter
12-
ALLSPHINXOPTS = -d .build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
13+
ALLSPHINXOPTS = -d $(BUILD_DIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) src
1314

1415
.PHONY: help clean html web htmlhelp latex changes linkcheck
1516

@@ -23,46 +24,46 @@ help:
2324
@echo " linkcheck to check all external links for integrity"
2425

2526
clean:
26-
-rm -rf .build/*
27+
-rm -rf $(BUILD_DIR)
2728

2829
html:
29-
mkdir -p .build/doctrees
30-
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) .build/html
30+
mkdir -p $(BUILD_DIR)/doctrees
31+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILD_DIR)/html
3132
@echo
32-
@echo "Build finished. The HTML pages are in .build/html"
33+
@echo "Build finished. The HTML pages are in $(BUILD_DIR)/html"
3334

3435
web:
35-
mkdir -p .build/web .build/doctrees
36-
$(SPHINXBUILD) -b web $(ALLSPHINXOPTS) .build/web
36+
mkdir -p $(BUILD_DIR)/web $(BUILD_DIR)/doctrees
37+
$(SPHINXBUILD) -b web $(ALLSPHINXOPTS) $(BUILD_DIR)/web
3738
@echo
3839
@echo "Build finished; now you can run"
39-
@echo " python -m sphinx.web .build/web"
40+
@echo " python -m sphinx.web $(BUILD_DIR)/web"
4041
@echo "to start the server."
4142

4243
htmlhelp:
43-
mkdir -p .build/htmlhelp .build/doctrees
44-
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) .build/htmlhelp
44+
mkdir -p $(BUILD_DIR)/htmlhelp $(BUILD_DIR)/doctrees
45+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILD_DIR)/htmlhelp
4546
@echo
4647
@echo "Build finished; now you can run HTML Help Workshop with the" \
47-
".hhp project file in .build/htmlhelp."
48+
".hhp project file in $(BUILD_DIR)/htmlhelp."
4849

4950
latex:
50-
mkdir -p .build/latex .build/doctrees
51-
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) .build/latex
51+
mkdir -p $(BUILD_DIR)/latex $(BUILD_DIR)/doctrees
52+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILD_DIR)/latex
5253
@echo
53-
@echo "Build finished; the LaTeX files are in .build/latex."
54+
@echo "Build finished; the LaTeX files are in $(BUILD_DIR)/latex."
5455
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
5556
"run these through (pdf)latex."
5657

5758
changes:
58-
mkdir -p .build/changes .build/doctrees
59-
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) .build/changes
59+
mkdir -p $(BUILD_DIR)/changes $(BUILD_DIR)/doctrees
60+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILD_DIR)/changes
6061
@echo
61-
@echo "The overview file is in .build/changes."
62+
@echo "The overview file is in $(BUILD_DIR)/changes."
6263

6364
linkcheck:
64-
mkdir -p .build/linkcheck .build/doctrees
65-
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) .build/linkcheck
65+
mkdir -p $(BUILD_DIR)/linkcheck $(BUILD_DIR)/doctrees
66+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILD_DIR)/linkcheck
6667
@echo
6768
@echo "Link check complete; look for any errors in the above output " \
68-
"or in .build/linkcheck/output.txt."
69+
"or in $(BUILD_DIR)/linkcheck/output.txt."
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)