diff options
author | Jake Hunsaker <jhunsake@redhat.com> | 2020-07-21 10:42:44 -0400 |
---|---|---|
committer | Bryan Quigley <code@bryanquigley.com> | 2020-07-27 16:39:26 -0700 |
commit | 7341823258791f13f24a8f61f93253aa426dd335 (patch) | |
tree | 0a1a537d3f5cdd3e8401c10e335e91283ad30b54 /docs | |
parent | fe8c80016d9e8a13130fe2c97840999930453ee8 (diff) | |
download | sos-7341823258791f13f24a8f61f93253aa426dd335.tar.gz |
[build] Remove Makefiles from tree
Removes all Makefiles from the tree, as of 4.0 the supported method of
packaging is via setuptools.
Related: #2160
Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Signed-off-by: Bryan Quigley <code@bryanquigley.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Makefile | 310 |
1 files changed, 0 insertions, 310 deletions
diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index 1270045d..00000000 --- a/docs/Makefile +++ /dev/null @@ -1,310 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = _build -DOCDESTDIR = ${DESTDIR}/usr/share/doc/sos - -# User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from https://www.sphinx-doc.org/) -endif - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext install-dir install-html install-dirhtml install-singlehtml install-pickle install-json install-htmlhelp install-qthelp install-epub install-latex install-text install-man install-texinfo install-info install-gettext install-changes install-linkcheck install-doctest install-xml install-pseudoxml install - -help: - @echo "Please use \`make <target>' where <target> is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - rm -rf $(BUILDDIR)/* - -install-dir: - install -d -m 0755 ${DOCDESTDIR} - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -install-html: install-dir - if test -d ${BUILDDIR}/html; then \ - cp -r ${BUILDDIR}/html ${DOCDESTDIR}; \ - else \ - exit 0; \ - fi - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -install-dirhtml: install-dir - if test -d ${BUILDDIR}/dirhtml; then \ - cp -r ${BUILDDIR}/dirhtml ${DOCDESTDIR}; \ - else \ - exit 0; \ - fi - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -install-singlehtml: install-dir - if test -d ${BUILDDIR}/singlehtml; then \ - cp -r ${BUILDDIR}/singlehtml ${DOCDESTDIR}; \ - else \ - exit 0; \ - fi -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -install-pickle: install-dir - if test -d ${BUILDDIR}/pickle; then \ - cp -r ${BUILDDIR}/pickle ${DOCDESTDIR}; \ - else \ - exit 0; \ - fi -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -install-json: install-dir - if test -d ${BUILDDIR}/json; then \ - cp -r ${BUILDDIR}/json ${DOCDESTDIR}; \ - else \ - exit 0; \ - fi - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -install-htmlhelp: install-dir - if test -d ${BUILDDIR}/htmlhelp; then \ - cp -r ${BUILDDIR}/htmlhelp ${DOCDESTDIR}; \ - else \ - exit 0; \ - fi - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/SoS.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SoS.qhc" - -install-qthelp: install-dir - if test -d ${BUILDDIR}/qthelp; then \ - cp -r ${BUILDDIR}/qthelp ${DOCDESTDIR}; \ - else \ - exit 0; \ - fi - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/SoS" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SoS" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -install-epub: install-dir - if test -d ${BUILDDIR}/epub; then \ - cp -r ${BUILDDIR}/epub ${DOCDESTDIR}; \ - else \ - exit 0; \ - fi - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -install-latex: install-dir - if test -d ${BUILDDIR}/latex; then \ - cp -r ${BUILDDIR}/latex ${DOCDESTDIR}; \ - else \ - exit 0; \ - fi - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -install-text: install-dir - if test -d ${BUILDDIR}/text; then \ - cp -r ${BUILDDIR}/text ${DOCDESTDIR}; \ - else \ - exit 0; \ - fi - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -install-man: - if test -d ${BUILDDIR}/man; then \ - gzip -c ${BUILDDIR}/man/sos.1 > ${BUILDDIR}/man/sos.1.gz; \ - install -m644 ${BUILDDIR}/man/sos.1.gz $(DESTDIR)/usr/share/man/man1; \ - else \ - exit 0; \ - fi - -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -install-texinfo: install-dir - if test -d ${BUILDDIR}/texinfo; then \ - cp -r ${BUILDDIR}/texinfo ${DOCDESTDIR}; \ - else \ - exit 0; \ - fi - -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -install-info: install-dir install-texinfo - -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -install-gettext: install-dir - if test -d ${BUILDDIR}/locale; then \ - cp -r ${BUILDDIR}/locale ${DOCDESTDIR}; \ - else \ - exit 0; \ - fi - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -install-changes: install-dir - if test -d ${BUILDDIR}/changes; then \ - cp -r ${BUILDDIR}/changes ${DOCDESTDIR}; \ - else \ - exit 0; \ - fi - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -install-linkcheck: install-dir - if test -d ${BUILDDIR}/linkcheck; then \ - cp -r ${BUILDDIR}/linkcheck ${DOCDESTDIR}; \ - else \ - exit 0; \ - fi - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -install-doctest: install-dir - if test -d ${BUILDDIR}/doctest; then \ - cp -r ${BUILDDIR}/doctest ${DOCDESTDIR}; \ - else \ - exit 0; \ - fi - -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." - -install-xml: install-dir - if test -d ${BUILDDIR}/xml; then \ - cp -r ${BUILDDIR}/xml ${DOCDESTDIR}; \ - else \ - exit 0; \ - fi - -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." - -install-pseudoxml: install-dir - if test -d ${BUILDDIR}/pseudoxml; then \ - cp -r ${BUILDDIR}/pseudoxml ${DOCDESTDIR}; \ - else \ - exit 0; \ - fi - -install: install-html install-dirhtml install-singlehtml install-pickle install-json install-htmlhelp install-qthelp install-epub install-latex install-text install-man install-texinfo install-info install-gettext install-changes install-linkcheck install-doctest install-xml install-pseudoxml |