[dpdk-dev,v1] doc: fix relative path of Nic table input file

Message ID 1480870057-1674-1-git-send-email-john.mcnamara@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
checkpatch/checkpatch success coding style OK

Commit Message

John McNamara Dec. 4, 2016, 4:47 p.m. UTC
  Fix relative path between sphinx conf.py file and Nic table file
to allow automatic build on ReadTheDocs.

Fixes: 9db3f52126fb ("doc: generate NIC overview table from ini files")

Signed-off-by: John McNamara <john.mcnamara@intel.com>
---
 doc/guides/conf.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
  

Comments

Ferruh Yigit Dec. 5, 2016, 10:19 a.m. UTC | #1
On 12/4/2016 4:47 PM, John McNamara wrote:
> Fix relative path between sphinx conf.py file and Nic table file
> to allow automatic build on ReadTheDocs.
> 
> Fixes: 9db3f52126fb ("doc: generate NIC overview table from ini files")
> 
> Signed-off-by: John McNamara <john.mcnamara@intel.com>

Tested-by: Ferruh Yigit <ferruh.yigit@intel.com>
  
De Lara Guarch, Pablo Dec. 5, 2016, 3:15 p.m. UTC | #2
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of John McNamara
> Sent: Sunday, December 04, 2016 4:48 PM
> To: dev@dpdk.org
> Cc: stable@dpdk.org; Mcnamara, John
> Subject: [dpdk-dev] [PATCH v1] doc: fix relative path of Nic table input file
> 
> Fix relative path between sphinx conf.py file and Nic table file
> to allow automatic build on ReadTheDocs.
> 
> Fixes: 9db3f52126fb ("doc: generate NIC overview table from ini files")
> 
> Signed-off-by: John McNamara <john.mcnamara@intel.com>

Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
  
Thomas Monjalon Dec. 6, 2016, 4:31 p.m. UTC | #3
> > Fix relative path between sphinx conf.py file and Nic table file
> > to allow automatic build on ReadTheDocs.
> > 
> > Fixes: 9db3f52126fb ("doc: generate NIC overview table from ini files")
> > 
> > Signed-off-by: John McNamara <john.mcnamara@intel.com>
> 
> Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>

Applied, thanks
  

Patch

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index 149bcdb..29e8efb 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -312,7 +312,8 @@  def print_table_divider(outfile, num_cols):
 
 
 def setup(app):
-    generate_nic_overview_table('doc/guides/nics/overview_table.txt')
+    table_file = dirname(__file__) + '/nics/overview_table.txt'
+    generate_nic_overview_table(table_file)
 
     if LooseVersion(sphinx_version) < LooseVersion('1.3.1'):
         print('Upgrade sphinx to version >= 1.3.1 for '