2016-10-23 20:14:24 +00:00
# Makefile for Sphinx documentation
#
2018-08-13 02:24:55 +00:00
# ************ IMPORTANT *****************
#
# ReadTheDocs DOES NOT USE THIS MAKEFILE,
# so any behaviour additions must be
# done via Sphinx Config not here
#
# ****************************************
2016-10-23 20:14:24 +00:00
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# User-friendly check for sphinx-build
i f e q ( $( shell which $ ( SPHINXBUILD ) >/dev /null 2>&1; echo $ $ ?) , 1 )
2018-07-25 04:30:15 +00:00
$(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 http : //sphinx -doc .org /)
2016-10-23 20:14:24 +00:00
e n d i f
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size = a4
PAPEROPT_letter = -D latex_paper_size = letter
2017-05-02 08:36:01 +00:00
ALLSPHINXOPTS = -d $( BUILDDIR) /doctrees $( PAPEROPT_$( PAPER) ) $( SPHINXOPTS) -w sphinx-warning-log.txt .
2016-10-23 20:14:24 +00:00
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $( PAPEROPT_$( PAPER) ) $( SPHINXOPTS) .
2018-07-25 04:30:15 +00:00
.PHONY : help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext dependencies version -specific -includes
2016-10-23 20:14:24 +00:00
help :
2018-07-25 04:30:15 +00:00
@echo "Please use \`make <target>\' where <target> is one of"
2016-10-23 20:14:24 +00:00
@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"
2018-07-25 04:30:15 +00:00
@echo " doctest to run all doctests embedded in the documentation (if enabled) "
2016-10-23 20:14:24 +00:00
clean :
rm -rf $( BUILDDIR) /*
2018-08-13 02:24:55 +00:00
html :
2016-10-23 20:14:24 +00:00
$( SPHINXBUILD) -b html $( ALLSPHINXOPTS) $( BUILDDIR) /html
@echo
@echo " Build finished. The HTML pages are in $( BUILDDIR) /html. "
2018-08-13 02:24:55 +00:00
dirhtml :
2016-10-23 20:14:24 +00:00
$( SPHINXBUILD) -b dirhtml $( ALLSPHINXOPTS) $( BUILDDIR) /dirhtml
@echo
@echo " Build finished. The HTML pages are in $( BUILDDIR) /dirhtml. "
2018-08-13 02:24:55 +00:00
singlehtml :
2016-10-23 20:14:24 +00:00
$( SPHINXBUILD) -b singlehtml $( ALLSPHINXOPTS) $( BUILDDIR) /singlehtml
@echo
@echo " Build finished. The HTML page is in $( BUILDDIR) /singlehtml. "
2018-08-13 02:24:55 +00:00
pickle :
2016-10-23 20:14:24 +00:00
$( SPHINXBUILD) -b pickle $( ALLSPHINXOPTS) $( BUILDDIR) /pickle
@echo
@echo "Build finished; now you can process the pickle files."
2018-08-13 02:24:55 +00:00
json :
2016-10-23 20:14:24 +00:00
$( SPHINXBUILD) -b json $( ALLSPHINXOPTS) $( BUILDDIR) /json
@echo
@echo "Build finished; now you can process the JSON files."
2018-08-13 02:24:55 +00:00
htmlhelp :
2016-10-23 20:14:24 +00:00
$( 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. "
2018-08-13 02:24:55 +00:00
qthelp :
2016-10-23 20:14:24 +00:00
$( 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/ReadtheDocsTemplate.qhcp "
@echo "To view the help file:"
@echo " # assistant -collectionFile $( BUILDDIR) /qthelp/ReadtheDocsTemplate.qhc "
2018-08-13 02:24:55 +00:00
devhelp :
2016-10-23 20:14:24 +00:00
$( SPHINXBUILD) -b devhelp $( ALLSPHINXOPTS) $( BUILDDIR) /devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo " # mkdir -p $$ HOME/.local/share/devhelp/ReadtheDocsTemplate "
@echo " # ln -s $( BUILDDIR) /devhelp $$ HOME/.local/share/devhelp/ReadtheDocsTemplate "
@echo "# devhelp"
2018-08-13 02:24:55 +00:00
epub :
2016-10-23 20:14:24 +00:00
$( SPHINXBUILD) -b epub $( ALLSPHINXOPTS) $( BUILDDIR) /epub
@echo
@echo " Build finished. The epub file is in $( BUILDDIR) /epub. "
2018-08-13 02:24:55 +00:00
latex :
2016-10-23 20:14:24 +00:00
$( 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)."
2018-08-13 02:24:55 +00:00
latexpdf :
2016-10-23 20:14:24 +00:00
$( 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. "
2018-08-13 02:24:55 +00:00
latexpdfja :
2016-10-23 20:14:24 +00:00
$( 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. "
2018-08-13 02:24:55 +00:00
text :
2016-10-23 20:14:24 +00:00
$( SPHINXBUILD) -b text $( ALLSPHINXOPTS) $( BUILDDIR) /text
@echo
@echo " Build finished. The text files are in $( BUILDDIR) /text. "
2018-08-13 02:24:55 +00:00
man :
2016-10-23 20:14:24 +00:00
$( SPHINXBUILD) -b man $( ALLSPHINXOPTS) $( BUILDDIR) /man
@echo
@echo " Build finished. The manual pages are in $( BUILDDIR) /man. "
2018-08-13 02:24:55 +00:00
texinfo :
2016-10-23 20:14:24 +00:00
$( 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)."
2018-08-13 02:24:55 +00:00
info :
2016-10-23 20:14:24 +00:00
$( 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. "
2018-08-13 02:24:55 +00:00
gettext :
2016-10-23 20:14:24 +00:00
$( SPHINXBUILD) -b gettext $( I18NSPHINXOPTS) $( BUILDDIR) /locale
@echo
@echo " Build finished. The message catalogs are in $( BUILDDIR) /locale. "
2018-08-13 02:24:55 +00:00
changes :
2016-10-23 20:14:24 +00:00
$( SPHINXBUILD) -b changes $( ALLSPHINXOPTS) $( BUILDDIR) /changes
@echo
@echo " The overview file is in $( BUILDDIR) /changes. "
2018-08-13 02:24:55 +00:00
linkcheck :
2016-10-23 20:14:24 +00:00
$( 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. "
2018-08-13 02:24:55 +00:00
gh-linkcheck :
2017-01-19 08:16:06 +00:00
@echo "Checking for hardcoded GitHub links"
@if ( find ../ -name '*.rst' | xargs grep \
'https://github.com/espressif/esp-idf/tree\|https://github.com/espressif/esp-idf/blob\|https://github.com/espressif/esp-idf/raw' \
) ; \
then \
echo "WARNINIG: Some .rst files contain hardcoded Github links." ; \
echo "Please check above output and replace links with one of the following:" ; \
echo "- :idf:\`dir\` - points to directory inside ESP-IDF" ; \
2017-05-02 08:36:01 +00:00
echo "- :idf_file:\`file\` - points to file inside ESP-IDF" ; \
2017-01-19 08:16:06 +00:00
echo "- :idf_raw:\`file\` - points to raw view of the file inside ESP-IDF" ; \
echo "- :component:\`dir\` - points to directory inside ESP-IDF components dir" ; \
2017-05-02 08:36:01 +00:00
echo "- :component_file:\`file\` - points to file inside ESP-IDF components dir" ; \
2017-01-19 08:16:06 +00:00
echo "- :component_raw:\`file\` - points to raw view of the file inside ESP-IDF" ; \
echo " components dir" ; \
echo "- :example:\`dir\` - points to directory inside ESP-IDF examples dir" ; \
2017-05-02 08:36:01 +00:00
echo "- :example_file:\`file\` - points to file inside ESP-IDF examples dir" ; \
2017-01-19 08:16:06 +00:00
echo "- :example_raw:\`file\` - points to raw view of the file inside ESP-IDF" ; \
echo " examples dir" ; \
echo "These link types will point to the correct GitHub version automatically" ; \
exit 1; \
fi
@echo "No hardcoded links found"
2018-08-13 02:24:55 +00:00
doctest :
2016-10-23 20:14:24 +00:00
$( SPHINXBUILD) -b doctest $( ALLSPHINXOPTS) $( BUILDDIR) /doctest
@echo "Testing of doctests in the sources finished, look at the " \
" results in $( BUILDDIR) /doctest/output.txt. "
2018-08-13 02:24:55 +00:00
xml :
2016-10-23 20:14:24 +00:00
$( SPHINXBUILD) -b xml $( ALLSPHINXOPTS) $( BUILDDIR) /xml
@echo
@echo " Build finished. The XML files are in $( BUILDDIR) /xml. "
2018-08-13 02:24:55 +00:00
pseudoxml :
2016-10-23 20:14:24 +00:00
$( SPHINXBUILD) -b pseudoxml $( ALLSPHINXOPTS) $( BUILDDIR) /pseudoxml
@echo
@echo " Build finished. The pseudo-XML files are in $( BUILDDIR) /pseudoxml. "