[dpdk-dev,v2,1/3] doc: set the default literal block format

Message ID 1436543121-26240-2-git-send-email-john.mcnamara@intel.com (mailing list archive)
State Accepted, archived
Headers

Commit Message

John McNamara July 10, 2015, 3:45 p.m. UTC
  Set the default literal block format for Sphinx docs
to 'none' instead of the implicit default of 'python'.

This means that default :: blocks won't have any
highlighting applied. Explicit highlighting via
the code-block:: directive is already available and
in use in the docs.

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

Comments

Bruce Richardson Aug. 5, 2015, 2:15 p.m. UTC | #1
On Fri, Jul 10, 2015 at 04:45:19PM +0100, John McNamara wrote:
> Set the default literal block format for Sphinx docs
> to 'none' instead of the implicit default of 'python'.
> 
> This means that default :: blocks won't have any
> highlighting applied. Explicit highlighting via
> the code-block:: directive is already available and
> in use in the docs.
> 
> Signed-off-by: John McNamara <john.mcnamara@intel.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
  

Patch

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index e1edffd..b2290b4 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -38,6 +38,7 @@  from pygments.formatters.latex import LatexFormatter
 project = 'DPDK'
 
 html_show_copyright = False
+highlight_language = 'none'
 
 version = subprocess.check_output(['make', '-sRrC', '../../', 'showversion']).decode('utf-8')
 release = version