1. 08 Sep, 2017 3 commits
  2. 26 Aug, 2017 1 commit
  3. 24 Aug, 2017 2 commits
  4. 23 Jun, 2017 2 commits
  5. 16 May, 2017 11 commits
  6. 05 Apr, 2017 1 commit
  7. 31 Mar, 2017 1 commit
  8. 09 Mar, 2017 1 commit
    • Markus Heiser's avatar
      docs-rst: automatically convert Graphviz and SVG images · db6ccf23
      Markus Heiser authored
      This patch brings scalable figure, image handling and a concept to
      embed *render* markups:
      
      * DOT (http://www.graphviz.org)
      * SVG
      
      For image handling use the 'image' replacement::
      
          .. kernel-image::  svg_image.svg
             :alt:    simple SVG image
      
      For figure handling use the 'figure' replacement::
      
          .. kernel-figure::  svg_image.svg
             :alt:    simple SVG image
      
             SVG image example
      
      Embed *render* markups (or languages) like Graphviz's **DOT** is
      provided by the *render* directive.::
      
        .. kernel-render:: DOT
           :alt: foobar digraph
           :caption: Embedded **DOT** (Graphviz) code.
      
           digraph foo {
            "bar" -> "baz";
           }
      
      The *render* directive is a concept to integrate *render* markups and
      languages, yet supported markups:
      
      * DOT: render embedded Graphviz's **DOT**
      * SVG: render embedded Scalable Vector Graphics (**SVG**)
      
      Cc: Jani Nikula <jani.nikula@linux.intel.com>
      Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
      Tested-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
      Tested-by: default avatarDaniel Vetter <daniel.vetter@ffwll.ch>
      Signed-off-by: Daniel Vetter <daniel.vetter@intel.com> (v2 - v5)
      Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> (v1, v6)
      Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      db6ccf23
  9. 03 Mar, 2017 1 commit
  10. 06 Feb, 2017 1 commit
  11. 19 Nov, 2016 1 commit
  12. 16 Nov, 2016 2 commits
  13. 03 Nov, 2016 2 commits
    • Jani Nikula's avatar
      Documentation/sphinx: set literal block highlight language to none · b459106e
      Jani Nikula authored
      Set the default highlight language to "none", i.e. do not try to guess
      the language and do automatic syntax highlighting on literal blocks.
      
      Eyeballing around the generated documentation, we don't seem to actually
      have a lot of literal blocks that would benefit from syntax
      highlighting. The C code blocks we do have are typically very short, and
      most of the literal blocks are things that shouldn't be highlighted (or,
      do not have a pygments lexer). This seems to be true for literal blocks
      both in the rst source files and in source code comments.
      
      Not highlighting code is never wrong, but guessing the language wrong
      almost invariably leads to silly or confusing highlighting.
      
      At the time of writing, admin-guide/oops-tracing.rst and
      admin-guide/ramoops.rst contain good examples of 1) a small C code
      snippet not highlighted, 2) a hex dump highligted as who knows what, 3)
      device tree block highlighted as C or maybe Python, 4) a terminal
      interaction highlighted as code in some language, and finally, 5) some C
      code snippets correctly identified as C. I think we're better off
      disabling language guessing, and going by explicitly identified
      languages for longer code blocks.
      
      It is still possible to enable highlighting on an rst source file basis
      using the highlight directive:
      
      .. higlight:: language
      
      and on a literal block basis using the code-block directive:
      
      .. code-block:: language
      
      See http://www.sphinx-doc.org/en/latest/markup/code.html for details.
      
      Cc: Jonathan Corbet <corbet@lwn.net>
      Cc: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
      Cc: Markus Heiser <markus.heiser@darmarit.de>
      Signed-off-by: default avatarJani Nikula <jani.nikula@intel.com>
      b459106e
    • Jani Nikula's avatar
      Documentation/sphinx: include admin-guide in the latex/pdf build · 8d26d90b
      Jani Nikula authored
      Fix the warning:
      
      WARNING: "latex_documents" config value references unknown document
      user/index
      Reviewed-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
      Signed-off-by: default avatarJani Nikula <jani.nikula@intel.com>
      8d26d90b
  14. 24 Oct, 2016 2 commits
  15. 19 Oct, 2016 1 commit
  16. 21 Sep, 2016 1 commit
  17. 23 Aug, 2016 1 commit
  18. 22 Aug, 2016 5 commits
  19. 18 Aug, 2016 1 commit