Skip to content

Commit 2b1b42f

Browse files
nchammasnchammas
committed
revert changes being tracked in other PRs
1 parent 25fdaef commit 2b1b42f

File tree

3 files changed

+358
-3
lines changed

3 files changed

+358
-3
lines changed

‎python/docs/Makefile‎

Lines changed: 154 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
# You can set these variables from the command line.
55
SPHINXOPTS ?=
66
SPHINXBUILD ?= sphinx-build
7+
PAPER ?=
78
BUILDDIR ?= _build
89

910
export PYTHONPATH=$(realpath ..):$(realpath ../lib/py4j-0.10.8.1-src.zip)
@@ -14,9 +15,38 @@ $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx in
1415
endif
1516

1617
# Internal variables.
17-
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(SPHINXOPTS) .
18+
PAPEROPT_a4 = -D latex_paper_size=a4
19+
PAPEROPT_letter = -D latex_paper_size=letter
20+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
21+
# the i18n builder cannot share the environment and doctrees with the others
22+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
1823

19-
.PHONY: help clean html
24+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
25+
26+
help:
27+
@echo "Please use \`make <target>' where <target> is one of"
28+
@echo " html to make standalone HTML files"
29+
@echo " dirhtml to make HTML files named index.html in directories"
30+
@echo " singlehtml to make a single large HTML file"
31+
@echo " pickle to make pickle files"
32+
@echo " json to make JSON files"
33+
@echo " htmlhelp to make HTML files and a HTML help project"
34+
@echo " qthelp to make HTML files and a qthelp project"
35+
@echo " devhelp to make HTML files and a Devhelp project"
36+
@echo " epub to make an epub"
37+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
38+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
39+
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
40+
@echo " text to make text files"
41+
@echo " man to make manual pages"
42+
@echo " texinfo to make Texinfo files"
43+
@echo " info to make Texinfo files and run them through makeinfo"
44+
@echo " gettext to make PO message catalogs"
45+
@echo " changes to make an overview of all changed/added/deprecated items"
46+
@echo " xml to make Docutils-native XML files"
47+
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
48+
@echo " linkcheck to check all external links for integrity"
49+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
2050

2151
clean:
2252
rm -rf $(BUILDDIR)/*
@@ -25,3 +55,125 @@ html:
2555
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
2656
@echo
2757
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
58+
59+
dirhtml:
60+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
61+
@echo
62+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
63+
64+
singlehtml:
65+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
66+
@echo
67+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
68+
69+
pickle:
70+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
71+
@echo
72+
@echo "Build finished; now you can process the pickle files."
73+
74+
json:
75+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
76+
@echo
77+
@echo "Build finished; now you can process the JSON files."
78+
79+
htmlhelp:
80+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
81+
@echo
82+
@echo "Build finished; now you can run HTML Help Workshop with the" \
83+
".hhp project file in $(BUILDDIR)/htmlhelp."
84+
85+
qthelp:
86+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
87+
@echo
88+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
89+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
90+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pyspark.qhcp"
91+
@echo "To view the help file:"
92+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pyspark.qhc"
93+
94+
devhelp:
95+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
96+
@echo
97+
@echo "Build finished."
98+
@echo "To view the help file:"
99+
@echo "# mkdir -p $$HOME/.local/share/devhelp/pyspark"
100+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pyspark"
101+
@echo "# devhelp"
102+
103+
epub:
104+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
105+
@echo
106+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
107+
108+
latex:
109+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
110+
@echo
111+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
112+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
113+
"(use \`make latexpdf' here to do that automatically)."
114+
115+
latexpdf:
116+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
117+
@echo "Running LaTeX files through pdflatex..."
118+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
119+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
120+
121+
latexpdfja:
122+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
123+
@echo "Running LaTeX files through platex and dvipdfmx..."
124+
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
125+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
126+
127+
text:
128+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
129+
@echo
130+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
131+
132+
man:
133+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
134+
@echo
135+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
136+
137+
texinfo:
138+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
139+
@echo
140+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
141+
@echo "Run \`make' in that directory to run these through makeinfo" \
142+
"(use \`make info' here to do that automatically)."
143+
144+
info:
145+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
146+
@echo "Running Texinfo files through makeinfo..."
147+
make -C $(BUILDDIR)/texinfo info
148+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
149+
150+
gettext:
151+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
152+
@echo
153+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
154+
155+
changes:
156+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
157+
@echo
158+
@echo "The overview file is in $(BUILDDIR)/changes."
159+
160+
linkcheck:
161+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
162+
@echo
163+
@echo "Link check complete; look for any errors in the above output " \
164+
"or in $(BUILDDIR)/linkcheck/output.txt."
165+
166+
doctest:
167+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
168+
@echo "Testing of doctests in the sources finished, look at the " \
169+
"results in $(BUILDDIR)/doctest/output.txt."
170+
171+
xml:
172+
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
173+
@echo
174+
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
175+
176+
pseudoxml:
177+
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
178+
@echo
179+
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

‎python/docs/make2.bat‎

Lines changed: 203 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,38 @@ if "%SPHINXBUILD%" == "" (
1010
)
1111
set BUILDDIR=_build
1212
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
13+
set I18NSPHINXOPTS=%SPHINXOPTS% .
14+
if NOT "%PAPER%" == "" (
15+
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
16+
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
17+
)
18+
19+
if "%1" == "" goto help
20+
21+
if "%1" == "help" (
22+
:help
23+
echo.Please use `make ^<target^>` where ^<target^> is one of
24+
echo. html to make standalone HTML files
25+
echo. dirhtml to make HTML files named index.html in directories
26+
echo. singlehtml to make a single large HTML file
27+
echo. pickle to make pickle files
28+
echo. json to make JSON files
29+
echo. htmlhelp to make HTML files and a HTML help project
30+
echo. qthelp to make HTML files and a qthelp project
31+
echo. devhelp to make HTML files and a Devhelp project
32+
echo. epub to make an epub
33+
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
34+
echo. text to make text files
35+
echo. man to make manual pages
36+
echo. texinfo to make Texinfo files
37+
echo. gettext to make PO message catalogs
38+
echo. changes to make an overview over all changed/added/deprecated items
39+
echo. xml to make Docutils-native XML files
40+
echo. pseudoxml to make pseudoxml-XML files for display purposes
41+
echo. linkcheck to check all external links for integrity
42+
echo. doctest to run all doctests embedded in the documentation if enabled
43+
goto end
44+
)
1345

1446
if "%1" == "clean" (
1547
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
@@ -39,4 +71,175 @@ if "%1" == "html" (
3971
goto end
4072
)
4173

74+
if "%1" == "dirhtml" (
75+
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
76+
if errorlevel 1 exit /b 1
77+
echo.
78+
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
79+
goto end
80+
)
81+
82+
if "%1" == "singlehtml" (
83+
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
84+
if errorlevel 1 exit /b 1
85+
echo.
86+
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
87+
goto end
88+
)
89+
90+
if "%1" == "pickle" (
91+
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
92+
if errorlevel 1 exit /b 1
93+
echo.
94+
echo.Build finished; now you can process the pickle files.
95+
goto end
96+
)
97+
98+
if "%1" == "json" (
99+
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
100+
if errorlevel 1 exit /b 1
101+
echo.
102+
echo.Build finished; now you can process the JSON files.
103+
goto end
104+
)
105+
106+
if "%1" == "htmlhelp" (
107+
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
108+
if errorlevel 1 exit /b 1
109+
echo.
110+
echo.Build finished; now you can run HTML Help Workshop with the ^
111+
.hhp project file in %BUILDDIR%/htmlhelp.
112+
goto end
113+
)
114+
115+
if "%1" == "qthelp" (
116+
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
117+
if errorlevel 1 exit /b 1
118+
echo.
119+
echo.Build finished; now you can run "qcollectiongenerator" with the ^
120+
.qhcp project file in %BUILDDIR%/qthelp, like this:
121+
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pyspark.qhcp
122+
echo.To view the help file:
123+
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pyspark.ghc
124+
goto end
125+
)
126+
127+
if "%1" == "devhelp" (
128+
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
129+
if errorlevel 1 exit /b 1
130+
echo.
131+
echo.Build finished.
132+
goto end
133+
)
134+
135+
if "%1" == "epub" (
136+
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
137+
if errorlevel 1 exit /b 1
138+
echo.
139+
echo.Build finished. The epub file is in %BUILDDIR%/epub.
140+
goto end
141+
)
142+
143+
if "%1" == "latex" (
144+
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
145+
if errorlevel 1 exit /b 1
146+
echo.
147+
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
148+
goto end
149+
)
150+
151+
if "%1" == "latexpdf" (
152+
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
153+
cd %BUILDDIR%/latex
154+
make all-pdf
155+
cd %BUILDDIR%/..
156+
echo.
157+
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
158+
goto end
159+
)
160+
161+
if "%1" == "latexpdfja" (
162+
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
163+
cd %BUILDDIR%/latex
164+
make all-pdf-ja
165+
cd %BUILDDIR%/..
166+
echo.
167+
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
168+
goto end
169+
)
170+
171+
if "%1" == "text" (
172+
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
173+
if errorlevel 1 exit /b 1
174+
echo.
175+
echo.Build finished. The text files are in %BUILDDIR%/text.
176+
goto end
177+
)
178+
179+
if "%1" == "man" (
180+
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
181+
if errorlevel 1 exit /b 1
182+
echo.
183+
echo.Build finished. The manual pages are in %BUILDDIR%/man.
184+
goto end
185+
)
186+
187+
if "%1" == "texinfo" (
188+
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
189+
if errorlevel 1 exit /b 1
190+
echo.
191+
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
192+
goto end
193+
)
194+
195+
if "%1" == "gettext" (
196+
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
197+
if errorlevel 1 exit /b 1
198+
echo.
199+
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
200+
goto end
201+
)
202+
203+
if "%1" == "changes" (
204+
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
205+
if errorlevel 1 exit /b 1
206+
echo.
207+
echo.The overview file is in %BUILDDIR%/changes.
208+
goto end
209+
)
210+
211+
if "%1" == "linkcheck" (
212+
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
213+
if errorlevel 1 exit /b 1
214+
echo.
215+
echo.Link check complete; look for any errors in the above output ^
216+
or in %BUILDDIR%/linkcheck/output.txt.
217+
goto end
218+
)
219+
220+
if "%1" == "doctest" (
221+
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
222+
if errorlevel 1 exit /b 1
223+
echo.
224+
echo.Testing of doctests in the sources finished, look at the ^
225+
results in %BUILDDIR%/doctest/output.txt.
226+
goto end
227+
)
228+
229+
if "%1" == "xml" (
230+
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
231+
if errorlevel 1 exit /b 1
232+
echo.
233+
echo.Build finished. The XML files are in %BUILDDIR%/xml.
234+
goto end
235+
)
236+
237+
if "%1" == "pseudoxml" (
238+
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
239+
if errorlevel 1 exit /b 1
240+
echo.
241+
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
242+
goto end
243+
)
244+
42245
:end

‎sql/mkdocs.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
site_name: Spark SQL, Built-in Functions
1717
theme: readthedocs
18-
nav:
18+
pages:
1919
- 'Functions': 'index.md'
2020
markdown_extensions:
2121
- toc:

0 commit comments

Comments
 (0)