From e5c31727d38bc7b13cbe8f2898df5ee4ba51a095 Mon Sep 17 00:00:00 2001
From: Andre Anjos <andre.dos.anjos@gmail.com>
Date: Sat, 16 Nov 2013 20:52:23 +0100
Subject: [PATCH] Fix docstrings for sphinx

---
 xbob/io/videoreader.cpp | 18 +++++++++---------
 xbob/io/videowriter.cpp |  2 +-
 2 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/xbob/io/videoreader.cpp b/xbob/io/videoreader.cpp
index e86ede8..42c5bbd 100644
--- a/xbob/io/videoreader.cpp
+++ b/xbob/io/videoreader.cpp
@@ -40,15 +40,15 @@ implementation uses `FFmpeg <http://ffmpeg.org>`_ (or\n\
 `libav <http://libav.org>`_ if FFmpeg is not available) which is\n\
 a stable freely available video encoding and decoding library,\n\
 designed specifically for these tasks. You can read an entire\n\
-video in memory by using the 'load()' method or use iterators\n\
-to read it frame by frame and avoid overloading your machine\'s\n\
-memory. The maximum precision data `FFmpeg`_ will yield is a 24-bit\n\
-(8-bit per band) representation of each pixel (32-bit depths are\n\
-also supported by `FFmpeg`_, but not by this extension presently).\n\
-So, the output of data is done with ``uint8`` as data type.\n\
-Output will be colored using the RGB standard, with each band\n\
-varying between 0 and 255, with zero meaning pure black and 255,\n\
-pure white (color).\n\
+video in memory by using the :py:meth:`xbob.io.VideoReader.load`\n\
+method or use iterators to read it frame by frame and avoid\n\
+overloading your machine\'s memory. The maximum precision data\n\
+`FFmpeg`_ will yield is a 24-bit (8-bit per band) representation\n\
+of each pixel (32-bit depths are also supported by `FFmpeg`_, but\n\
+not by this extension presently). So, the output of data is done\n\
+with ``uint8`` as data type. Output will be colored using the RGB\n\
+standard, with each band varying between 0 and 255, with zero\n\
+meaning pure black and 255, pure white (color).\n\
 \n\
 ");
 
diff --git a/xbob/io/videowriter.cpp b/xbob/io/videowriter.cpp
index 19b50a8..a7122ef 100644
--- a/xbob/io/videowriter.cpp
+++ b/xbob/io/videowriter.cpp
@@ -42,7 +42,7 @@ bitrate\n\
 \n\
 gop\n\
   [int, optional] Group-of-Pictures (emit one intra frame\n\
-  every `gop' frames at most).\n\
+  every ``gop`` frames at most).\n\
 \n\
 codec\n\
   [str, optional] If you must, specify a valid FFmpeg codec\n\
-- 
GitLab