Skip to content

Commit d03ce3d

Browse files
hugovkradarhere
hugovk
and
radarhere
authored
Docs: remove unused Makefile targets (#8917)
Co-authored-by: Andrew Murray <[email protected]>
1 parent 4402797 commit d03ce3d

File tree

3 files changed

+0
-349
lines changed

3 files changed

+0
-349
lines changed

‎docs/Makefile‎

Lines changed: 0 additions & 135 deletions
Original file line numberDiff line numberDiff line change
@@ -24,22 +24,7 @@ help:
2424
@echo " serve to start a local server for viewing docs"
2525
@echo " dirhtml to make HTML files named index.html in directories"
2626
@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 " latexpdf to make LaTeX files and run them through pdflatex"
35-
@echo " text to make text files"
36-
@echo " man to make manual pages"
37-
@echo " texinfo to make Texinfo files"
38-
@echo " info to make Texinfo files and run them through makeinfo"
39-
@echo " gettext to make PO message catalogs"
40-
@echo " changes to make an overview of all changed/added/deprecated items"
4127
@echo " linkcheck to check all external links for integrity"
42-
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
4328

4429
.PHONY: clean
4530
clean:
@@ -69,119 +54,6 @@ singlehtml:
6954
@echo
7055
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
7156

72-
.PHONY: pickle
73-
pickle:
74-
$(MAKE) install-sphinx
75-
$(SPHINXBUILD) --builder pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
76-
@echo
77-
@echo "Build finished; now you can process the pickle files."
78-
79-
.PHONY: json
80-
json:
81-
$(MAKE) install-sphinx
82-
$(SPHINXBUILD) --builder json $(ALLSPHINXOPTS) $(BUILDDIR)/json
83-
@echo
84-
@echo "Build finished; now you can process the JSON files."
85-
86-
.PHONY: htmlhelp
87-
htmlhelp:
88-
$(MAKE) install-sphinx
89-
$(SPHINXBUILD) --builder htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
90-
@echo
91-
@echo "Build finished; now you can run HTML Help Workshop with the" \
92-
".hhp project file in $(BUILDDIR)/htmlhelp."
93-
94-
.PHONY: qthelp
95-
qthelp:
96-
$(MAKE) install-sphinx
97-
$(SPHINXBUILD) --builder qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
98-
@echo
99-
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
100-
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
101-
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PillowPILfork.qhcp"
102-
@echo "To view the help file:"
103-
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PillowPILfork.qhc"
104-
105-
.PHONY: devhelp
106-
devhelp:
107-
$(MAKE) install-sphinx
108-
$(SPHINXBUILD) --builder devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
109-
@echo
110-
@echo "Build finished."
111-
@echo "To view the help file:"
112-
@echo "# mkdir -p $$HOME/.local/share/devhelp/PillowPILfork"
113-
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PillowPILfork"
114-
@echo "# devhelp"
115-
116-
.PHONY: epub
117-
epub:
118-
$(MAKE) install-sphinx
119-
$(SPHINXBUILD) --builder epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
120-
@echo
121-
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
122-
123-
.PHONY: latex
124-
latex:
125-
$(MAKE) install-sphinx
126-
$(SPHINXBUILD) --builder latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
127-
@echo
128-
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
129-
@echo "Run \`make' in that directory to run these through (pdf)latex" \
130-
"(use \`make latexpdf' here to do that automatically)."
131-
132-
.PHONY: latexpdf
133-
latexpdf:
134-
$(MAKE) install-sphinx
135-
$(SPHINXBUILD) --builder latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
136-
@echo "Running LaTeX files through pdflatex..."
137-
$(MAKE) -C $(BUILDDIR)/latex all-pdf
138-
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
139-
140-
.PHONY: text
141-
text:
142-
$(MAKE) install-sphinx
143-
$(SPHINXBUILD) --builder text $(ALLSPHINXOPTS) $(BUILDDIR)/text
144-
@echo
145-
@echo "Build finished. The text files are in $(BUILDDIR)/text."
146-
147-
.PHONY: man
148-
man:
149-
$(MAKE) install-sphinx
150-
$(SPHINXBUILD) --builder man $(ALLSPHINXOPTS) $(BUILDDIR)/man
151-
@echo
152-
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
153-
154-
.PHONY: texinfo
155-
texinfo:
156-
$(MAKE) install-sphinx
157-
$(SPHINXBUILD) --builder texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
158-
@echo
159-
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
160-
@echo "Run \`make' in that directory to run these through makeinfo" \
161-
"(use \`make info' here to do that automatically)."
162-
163-
.PHONY: info
164-
info:
165-
$(MAKE) install-sphinx
166-
$(SPHINXBUILD) --builder texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
167-
@echo "Running Texinfo files through makeinfo..."
168-
make -C $(BUILDDIR)/texinfo info
169-
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
170-
171-
.PHONY: gettext
172-
gettext:
173-
$(MAKE) install-sphinx
174-
$(SPHINXBUILD) --builder gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
175-
@echo
176-
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
177-
178-
.PHONY: changes
179-
changes:
180-
$(MAKE) install-sphinx
181-
$(SPHINXBUILD) --builder changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
182-
@echo
183-
@echo "The overview file is in $(BUILDDIR)/changes."
184-
18557
.PHONY: linkcheck
18658
linkcheck:
18759
$(MAKE) install-sphinx
@@ -190,13 +62,6 @@ linkcheck:
19062
@echo "Link check complete; look for any errors in the above output " \
19163
"or in $(BUILDDIR)/linkcheck/output.txt."
19264

193-
.PHONY: doctest
194-
doctest:
195-
$(MAKE) install-sphinx
196-
$(SPHINXBUILD) --builder doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
197-
@echo "Testing of doctests in the sources finished, look at the " \
198-
"results in $(BUILDDIR)/doctest/output.txt."
199-
20065
.PHONY: htmlview
20166
htmlview: html
20267
$(PYTHON) -c "import os, webbrowser; webbrowser.open('file://' + os.path.realpath('$(BUILDDIR)/html/index.html'))"

‎docs/conf.py‎

Lines changed: 0 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -229,97 +229,6 @@
229229
# implements a search results scorer. If empty, the default will be used.
230230
# html_search_scorer = 'scorer.js'
231231

232-
# Output file base name for HTML help builder.
233-
htmlhelp_basename = "PillowPILForkdoc"
234-
235-
# -- Options for LaTeX output ---------------------------------------------
236-
237-
latex_elements: dict[str, str] = {
238-
# The paper size ('letterpaper' or 'a4paper').
239-
# 'papersize': 'letterpaper',
240-
# The font size ('10pt', '11pt' or '12pt').
241-
# 'pointsize': '10pt',
242-
# Additional stuff for the LaTeX preamble.
243-
# 'preamble': '',
244-
# Latex figure (float) alignment
245-
# 'figure_align': 'htbp',
246-
}
247-
248-
# Grouping the document tree into LaTeX files. List of tuples
249-
# (source start file, target name, title,
250-
# author, documentclass [howto, manual, or own class]).
251-
latex_documents = [
252-
(
253-
master_doc,
254-
"PillowPILFork.tex",
255-
"Pillow (PIL Fork) Documentation",
256-
"Jeffrey A. Clark",
257-
"manual",
258-
)
259-
]
260-
261-
# The name of an image file (relative to this directory) to place at the top of
262-
# the title page.
263-
# latex_logo = None
264-
265-
# For "manual" documents, if this is true, then toplevel headings are parts,
266-
# not chapters.
267-
# latex_use_parts = False
268-
269-
# If true, show page references after internal links.
270-
# latex_show_pagerefs = False
271-
272-
# If true, show URL addresses after external links.
273-
# latex_show_urls = False
274-
275-
# Documents to append as an appendix to all manuals.
276-
# latex_appendices = []
277-
278-
# If false, no module index is generated.
279-
# latex_domain_indices = True
280-
281-
282-
# -- Options for manual page output ---------------------------------------
283-
284-
# One entry per manual page. List of tuples
285-
# (source start file, name, description, authors, manual section).
286-
man_pages = [
287-
(master_doc, "pillowpilfork", "Pillow (PIL Fork) Documentation", [author], 1)
288-
]
289-
290-
# If true, show URL addresses after external links.
291-
# man_show_urls = False
292-
293-
294-
# -- Options for Texinfo output -------------------------------------------
295-
296-
# Grouping the document tree into Texinfo files. List of tuples
297-
# (source start file, target name, title, author,
298-
# dir menu entry, description, category)
299-
texinfo_documents = [
300-
(
301-
master_doc,
302-
"PillowPILFork",
303-
"Pillow (PIL Fork) Documentation",
304-
author,
305-
"PillowPILFork",
306-
"Pillow is the friendly PIL fork by Jeffrey A. Clark and contributors.",
307-
"Miscellaneous",
308-
)
309-
]
310-
311-
# Documents to append as an appendix to all manuals.
312-
# texinfo_appendices = []
313-
314-
# If false, no module index is generated.
315-
# texinfo_domain_indices = True
316-
317-
# How to display URL addresses: 'footnote', 'no', or 'inline'.
318-
# texinfo_show_urls = 'footnote'
319-
320-
# If true, do not generate a @detailmenu in the "Top" node's menu.
321-
# texinfo_no_detailmenu = False
322-
323232

324233
linkcheck_allowed_redirects = {
325234
r"https://www.bestpractices.dev/projects/6331": r"https://www.bestpractices.dev/en/.*",

‎docs/make.bat‎

Lines changed: 0 additions & 123 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,7 @@ if "%1" == "help" (
2222
echo. htmlview to open the index page built by the html target in your browser
2323
echo. dirhtml to make HTML files named index.html in directories
2424
echo. singlehtml to make a single large HTML file
25-
echo. pickle to make pickle files
26-
echo. json to make JSON files
27-
echo. htmlhelp to make HTML files and a HTML help project
28-
echo. qthelp to make HTML files and a qthelp project
29-
echo. devhelp to make HTML files and a Devhelp project
30-
echo. epub to make an epub
31-
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
32-
echo. text to make text files
33-
echo. man to make manual pages
34-
echo. texinfo to make Texinfo files
35-
echo. gettext to make PO message catalogs
36-
echo. changes to make an overview over all changed/added/deprecated items
3725
echo. linkcheck to check all external links for integrity
38-
echo. doctest to run all doctests embedded in the documentation if enabled
3926
goto end
4027
)
4128

@@ -80,107 +67,6 @@ if "%1" == "singlehtml" (
8067
goto end
8168
)
8269

83-
if "%1" == "pickle" (
84-
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
85-
if errorlevel 1 exit /b 1
86-
echo.
87-
echo.Build finished; now you can process the pickle files.
88-
goto end
89-
)
90-
91-
if "%1" == "json" (
92-
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
93-
if errorlevel 1 exit /b 1
94-
echo.
95-
echo.Build finished; now you can process the JSON files.
96-
goto end
97-
)
98-
99-
if "%1" == "htmlhelp" (
100-
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
101-
if errorlevel 1 exit /b 1
102-
echo.
103-
echo.Build finished; now you can run HTML Help Workshop with the ^
104-
.hhp project file in %BUILDDIR%/htmlhelp.
105-
goto end
106-
)
107-
108-
if "%1" == "qthelp" (
109-
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
110-
if errorlevel 1 exit /b 1
111-
echo.
112-
echo.Build finished; now you can run "qcollectiongenerator" with the ^
113-
.qhcp project file in %BUILDDIR%/qthelp, like this:
114-
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\PillowPILfork.qhcp
115-
echo.To view the help file:
116-
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\PillowPILfork.ghc
117-
goto end
118-
)
119-
120-
if "%1" == "devhelp" (
121-
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
122-
if errorlevel 1 exit /b 1
123-
echo.
124-
echo.Build finished.
125-
goto end
126-
)
127-
128-
if "%1" == "epub" (
129-
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
130-
if errorlevel 1 exit /b 1
131-
echo.
132-
echo.Build finished. The epub file is in %BUILDDIR%/epub.
133-
goto end
134-
)
135-
136-
if "%1" == "latex" (
137-
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
138-
if errorlevel 1 exit /b 1
139-
echo.
140-
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
141-
goto end
142-
)
143-
144-
if "%1" == "text" (
145-
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
146-
if errorlevel 1 exit /b 1
147-
echo.
148-
echo.Build finished. The text files are in %BUILDDIR%/text.
149-
goto end
150-
)
151-
152-
if "%1" == "man" (
153-
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
154-
if errorlevel 1 exit /b 1
155-
echo.
156-
echo.Build finished. The manual pages are in %BUILDDIR%/man.
157-
goto end
158-
)
159-
160-
if "%1" == "texinfo" (
161-
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
162-
if errorlevel 1 exit /b 1
163-
echo.
164-
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
165-
goto end
166-
)
167-
168-
if "%1" == "gettext" (
169-
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
170-
if errorlevel 1 exit /b 1
171-
echo.
172-
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
173-
goto end
174-
)
175-
176-
if "%1" == "changes" (
177-
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
178-
if errorlevel 1 exit /b 1
179-
echo.
180-
echo.The overview file is in %BUILDDIR%/changes.
181-
goto end
182-
)
183-
18470
if "%1" == "linkcheck" (
18571
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
18672
if errorlevel 1 exit /b 1
@@ -190,13 +76,4 @@ or in %BUILDDIR%/linkcheck/output.txt.
19076
goto end
19177
)
19278

193-
if "%1" == "doctest" (
194-
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
195-
if errorlevel 1 exit /b 1
196-
echo.
197-
echo.Testing of doctests in the sources finished, look at the ^
198-
results in %BUILDDIR%/doctest/output.txt.
199-
goto end
200-
)
201-
20279
:end

0 commit comments

Comments
 (0)