DPDK patches and discussions
 help / color / mirror / Atom feed
From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: thomas@monjalon.net, Bruce Richardson <bruce.richardson@intel.com>
Subject: [dpdk-dev] [PATCH 2/4] doc/api: align output folder with sphinx guides
Date: Tue, 29 Sep 2020 16:34:11 +0100	[thread overview]
Message-ID: <20200929153413.280581-3-bruce.richardson@intel.com> (raw)
In-Reply-To: <20200929153413.280581-1-bruce.richardson@intel.com>

The API docs were output to "<build>/doc/api/api" folder, which was
ugly-looking with the repeated "api", and inconsistent with the sphinx
guides which were written to "<build>/doc/guides/html". Changing the doxgen
output folder to "html" fixes both these issues.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/api/meson.build | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/api/meson.build b/doc/api/meson.build
index 49d5b9a15..e9b49f9c2 100644
--- a/doc/api/meson.build
+++ b/doc/api/meson.build
@@ -34,7 +34,7 @@ cdata = configuration_data()
 cdata.set('VERSION', meson.project_version())
 cdata.set('API_EXAMPLES', join_paths(meson.build_root(), 'doc', 'api', 'examples.dox'))
 cdata.set('OUTPUT', join_paths(meson.build_root(), 'doc', 'api'))
-cdata.set('HTML_OUTPUT', 'api')
+cdata.set('HTML_OUTPUT', 'html')
 cdata.set('TOPDIR', meson.source_root())
 cdata.set('STRIP_FROM_PATH', meson.source_root())
 
@@ -45,8 +45,8 @@ doxy_conf = configure_file(input: 'doxy-api.conf.in',
 doxy_build = custom_target('doxygen',
 	depends: example,
 	input: doxy_conf,
-	output: 'api',
-	depfile: 'api.d',
+	output: 'html',
+	depfile: 'html.d',
 	command: [generate_doxygen, '@INPUT@', '@OUTPUT@', generate_css],
 	install: get_option('enable_docs'),
 	install_dir: htmldir,
-- 
2.25.1


  parent reply	other threads:[~2020-09-29 15:34 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-29 15:34 [dpdk-dev] [PATCH 0/4] improve output when building docs Bruce Richardson
2020-09-29 15:34 ` [dpdk-dev] [PATCH 1/4] doc/api: hide verbose doxygen standard output Bruce Richardson
2020-09-29 15:55   ` Thomas Monjalon
2020-09-29 16:23     ` Bruce Richardson
2020-09-29 16:31       ` Thomas Monjalon
2020-09-29 16:40         ` Bruce Richardson
2020-09-29 15:34 ` Bruce Richardson [this message]
2020-09-29 15:34 ` [dpdk-dev] [PATCH 3/4] doc/api: put output log file in build directory Bruce Richardson
2020-09-29 15:34 ` [dpdk-dev] [PATCH 4/4] doc/guides: suppress printing out standard output Bruce Richardson
2020-09-29 16:54 ` [dpdk-dev] [PATCH v2 0/6] improve building docs Bruce Richardson
2020-09-29 16:54   ` [dpdk-dev] [PATCH v2 1/6] doc/api: hide verbose doxygen standard output Bruce Richardson
2020-09-29 16:54   ` [dpdk-dev] [PATCH v2 2/6] doc/api: align output folder with sphinx guides Bruce Richardson
2020-09-29 16:54   ` [dpdk-dev] [PATCH v2 3/6] doc/api: put output log file in build directory Bruce Richardson
2020-09-29 16:55   ` [dpdk-dev] [PATCH v2 4/6] doc/guides: suppress printing out standard output Bruce Richardson
2020-09-29 16:55   ` [dpdk-dev] [PATCH v2 5/6] ethdev: fix mis-named parameter Bruce Richardson
2020-09-29 17:34     ` David Marchand
2020-09-29 17:34     ` Thomas Monjalon
2020-09-30  9:01       ` Bruce Richardson
2020-09-29 16:55   ` [dpdk-dev] [PATCH v2 6/6] doc/api: make doc warnings errors when werror option set Bruce Richardson
2020-09-29 17:33     ` Thomas Monjalon
2020-09-30 14:32   ` [dpdk-dev] [PATCH v2 0/6] improve building docs Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200929153413.280581-3-bruce.richardson@intel.com \
    --to=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    --cc=thomas@monjalon.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).