[
https://issues.apache.org/jira/browse/TS-3700?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Oknet Xu updated TS-3700:
-------------------------
Description:
warning message:
Running Sphinx v1.1.3
WARNING: Doxygen files not found: xml/index.xml
The files are used to add links from an API description to the source
code for that object.
Run "$ make doxygen" to generate these XML files.
here is the patch:
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 557d8a4..4ff456f 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -35,9 +35,11 @@ endif
clean-local:
-rm -rf $(BUILDDIR)/* _build/html/* xml
-doxygen: Doxyfile
+xml/index.xml: Doxyfile
$(DOXYGEN)
+doxygen: xml/index.xml
+
# Makefile for Sphinx documentation
#
@@ -71,32 +73,32 @@ help:
@echo " changes to make an overview of all changed/added/deprecated
items"
@echo " linkcheck to check all external links for integrity"
-html-local:
+html-local: doxygen
$(SBUILD) -d $(BUILDDIR)/doctrees -b html $(srcdir) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
-dirhtml:
+dirhtml: doxygen
$(SBUILD) -d $(BUILDDIR)/doctrees -b dirhtml $(srcdir) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
-singlehtml:
+singlehtml: doxygen
$(SBUILD) -d $(BUILDDIR)/doctrees -b singlehtml $(srcdir)
$(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
-epub:
+epub: doxygen
$(SBUILD) -d $(BUILDDIR)/doctrees -b epub $(srcdir) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
-latex:
+latex: doxygen
$(SBUILD) -d $(BUILDDIR)/doctrees -b latex $(srcdir) $(BUILDDIR)/latex
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/latex."
-man:
+man: doxygen
$(SBUILD) -d $(BUILDDIR)/doctrees -b man $(srcdir) $(BUILDDIR)/man
@echo
@echo "Build finished. The man pages are in $(BUILDDIR)/man."
was:
warning message:
Running Sphinx v1.1.3
WARNING: Doxygen files not found: xml/index.xml
The files are used to add links from an API description to the source
code for that object.
Run "$ make doxygen" to generate these XML files.
here is the patch:
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 557d8a4..e162484 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -71,32 +71,32 @@ help:
@echo " changes to make an overview of all changed/added/deprecated
items"
@echo " linkcheck to check all external links for integrity"
-html-local:
+html-local: doxygen
$(SBUILD) -d $(BUILDDIR)/doctrees -b html $(srcdir) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
-dirhtml:
+dirhtml: doxygen
$(SBUILD) -d $(BUILDDIR)/doctrees -b dirhtml $(srcdir) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
-singlehtml:
+singlehtml: doxygen
$(SBUILD) -d $(BUILDDIR)/doctrees -b singlehtml $(srcdir)
$(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
-epub:
+epub: doxygen
$(SBUILD) -d $(BUILDDIR)/doctrees -b epub $(srcdir) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
-latex:
+latex: doxygen
$(SBUILD) -d $(BUILDDIR)/doctrees -b latex $(srcdir) $(BUILDDIR)/latex
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/latex."
-man:
+man: doxygen
$(SBUILD) -d $(BUILDDIR)/doctrees -b man $(srcdir) $(BUILDDIR)/man
@echo
@echo "Build finished. The man pages are in $(BUILDDIR)/man."
> should run doxygen before running sphinx
> ----------------------------------------
>
> Key: TS-3700
> URL: https://issues.apache.org/jira/browse/TS-3700
> Project: Traffic Server
> Issue Type: Bug
> Components: Docs
> Reporter: Oknet Xu
>
> warning message:
> Running Sphinx v1.1.3
> WARNING: Doxygen files not found: xml/index.xml
> The files are used to add links from an API description to the source
> code for that object.
> Run "$ make doxygen" to generate these XML files.
> here is the patch:
> diff --git a/doc/Makefile.am b/doc/Makefile.am
> index 557d8a4..4ff456f 100644
> --- a/doc/Makefile.am
> +++ b/doc/Makefile.am
> @@ -35,9 +35,11 @@ endif
> clean-local:
> -rm -rf $(BUILDDIR)/* _build/html/* xml
>
> -doxygen: Doxyfile
> +xml/index.xml: Doxyfile
> $(DOXYGEN)
>
> +doxygen: xml/index.xml
> +
> # Makefile for Sphinx documentation
> #
>
> @@ -71,32 +73,32 @@ help:
> @echo " changes to make an overview of all
> changed/added/deprecated items"
> @echo " linkcheck to check all external links for integrity"
>
> -html-local:
> +html-local: doxygen
> $(SBUILD) -d $(BUILDDIR)/doctrees -b html $(srcdir) $(BUILDDIR)/html
> @echo
> @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
>
> -dirhtml:
> +dirhtml: doxygen
> $(SBUILD) -d $(BUILDDIR)/doctrees -b dirhtml $(srcdir)
> $(BUILDDIR)/html
> @echo
> @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
>
> -singlehtml:
> +singlehtml: doxygen
> $(SBUILD) -d $(BUILDDIR)/doctrees -b singlehtml $(srcdir)
> $(BUILDDIR)/singlehtml
> @echo
> @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
>
> -epub:
> +epub: doxygen
> $(SBUILD) -d $(BUILDDIR)/doctrees -b epub $(srcdir) $(BUILDDIR)/epub
> @echo
> @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
>
> -latex:
> +latex: doxygen
> $(SBUILD) -d $(BUILDDIR)/doctrees -b latex $(srcdir) $(BUILDDIR)/latex
> @echo
> @echo "Build finished. The epub file is in $(BUILDDIR)/latex."
>
> -man:
> +man: doxygen
> $(SBUILD) -d $(BUILDDIR)/doctrees -b man $(srcdir) $(BUILDDIR)/man
> @echo
> @echo "Build finished. The man pages are in $(BUILDDIR)/man."
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
