Merge pull request #523 from gpotter2/patch-6

[General] Doc improvements + mercurial logs removed 

.hgsigs

-1fe855059e5c67fdd8984045916dc959b7688881 0 iD8DBQBFu5AqXuj/Xz2aQ+IRAndrAJoDun1mMGRkCUoERUd42b5bQ4lzRgCgqpXpzIFw00mjIv1ErnESkLYfziA=
-35c358be00fede40334734d6ae1d263a266c3701 0 iD8DBQBGE5vPXuj/Xz2aQ+IRAgpuAKC4SxP4WVu5PgiW5150iKZ79wIr/QCfVHcMQInO3jzhhLdVseT9PB/xv7Q=
-d8a91f28e741bb8af8975658a8a5a539107c1ea2 0 iD8DBQBGGjz5Xuj/Xz2aQ+IRAmNHAJ9ttQ67KKbqYse4af4hgwdYPWxdiwCgg1+4HS9sREyplo/0GMS8XOfSnck=
-105de7dc59f734c36488fd77926ca65b675bf541 0 iD8DBQBG6nscXuj/Xz2aQ+IRAkQbAJ47GgD2QrQdAq/R+GxYuqTuJs3khQCfd8w+LKvcyWLdl+sbYNjXjPnhTpk=
-9642ec17c7b8b63297bf9372f2d8084053304e79 0 iEYEABECAAYFAkmQI/4ACgkQXuj/Xz2aQ+IGVQCdH2MFM/AmFknON6PGBy5jtYmBXi8AoImp0HqW0KDawiRhw8N3oAy9bSd5
-8ac76c4dfc2ea44482d2e68a9877a80ae433467e 0 iEYEABECAAYFAksmWiwACgkQXuj/Xz2aQ+J/QwCgsEQnlxjr2HfXsOELtE6wRvH7BaMAn2tAfl9Z1JanqS7YvP1yXtTCaQJx
-9bea293f85d7f365ab1f30bfa0d266565c3ed86b 0 iEYEABECAAYFAku/q/wACgkQXuj/Xz2aQ+L03wCfTB+QAsTvFThjdOsLExmQmC0ISvAAoIajI2EMebxeth6HbRtXoLFm2ETB
-2e1a9aa8524281f7e4c9c0b93e0f017e50d2baf7 0 iEYEABECAAYFAk1rBKoACgkQXuj/Xz2aQ+LKVwCgsmmSEzijKWqm5/+spP0Ro2/vSvMAmgP3551nDejeo6Wbklkn0XaTpY/C
-5fc129d8cfd03ebef14bb84a6a6550a997aff149 0 iQEcBAABAgAGBQJUkXN+AAoJEJw6PF/j7UG9zskH/iQvlCuY7EMi+y2BOZPIUerSzC/vlwhc7kjuAKXQsSoNDKCAjztc53/kvnOyhc//eQEPC16B89jYm+SqHtSD9GJO2cX+oZfJPrxdidA2wafiLN32p1w98yWS270yvkYlC1aPwebJe/+DP6Ww5bC+8u/G8RCJAdEE47FVm3Q6RWX+UiaRNHF8HuFORpIMM6E68hIGJLb/svJatx6b9488YjB0Pn1tJqzdd6xsRNGYgsSchvgxCVXuP6RG/bMms6w/w408Sn9lvuYRpTgljvUr4j9KSm2w2zn5uud4FLO2OUk2H+KuQV8pAru12IZxvhtSlPnEXeVAveyD+XGh2p2FlKY=
-8e04919bddd5f39e7110d7d6b7e6bf7502b89c6d 0 iQEcBAABAgAGBQJUmVIyAAoJEJw6PF/j7UG9s8YH/09Dp155AbAkoA09JeLZk/Pjm0eD722X/YnGMV0tLzFN0gLGxkuRnSfpjfjvbW9zi7v/GwZsjyftXnoPlb5N74gA8pCjdAbYvTdNlraIwup52gIUc+WxD/DsirHI1oganBEu5xlYvTCffIqOkHJ4lLFghlVJOHRv/SFUp+6IbGXERdCcD+Rh3pXUUXdVmpkwaVld/cPJgNfDW77JRhzEy9yPB6vNTV3g8CQ+popSVNvh6qdPbajvFPBZYjRc1H2LyP0B6VDUyph+D4PojAkJ9APrhKrBx1447VYkacn15Ix0ysaY0vx78/bgHW7konOsxNqvcENKd9zxfNBwY/kKaIA=

doc/scapy/BuildDoc.bat

 @echo off
 title Build scapy docs
-set /P CLEAR=Clear build ? (y/n)
+set /P CLEAR=Clear build ? (y/n) [y] 
 If /I "%CLEAR%"=="y" goto yes 
+If /I "%CLEAR%"=="" goto yes 
 If /I "%CLEAR%"=="n" goto no
 
 echo Unknown answer !

doc/scapy/conf.py

 # -*- coding: utf-8 -*-
 #
-# Scapy documentation build configuration file, created by
-# sphinx-quickstart on Mon Sep  8 19:37:39 2008.
+# Scapy documentation build configuration file.
 #
 # This file is execfile()d with the current directory set to its containing dir.
 #
@@ -42,9 +41,9 @@ copyright = '2008, 2016 Philippe Biondi and the Scapy community'
 # other places throughout the built documents.
 #
 # The short X.Y version.
-version = '2.3.1'
+version = '2.3.3'
 # The full version, including alpha/beta/rc tags.
-release = '2.3.1-dev'
+release = '2.3.3-dev'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -80,6 +79,10 @@ pygments_style = 'sphinx'
 # Options for HTML output
 # -----------------------
 
+# Auto detect sphinx rtd. If set to True, if sphinx rtd is installed, it will be
+# automatically used.
+auto_rtd = True
+
 # The style sheet to use for HTML and HTML Help pages. A file of that name
 # must exist either in Sphinx' static/ path, or in one of the custom paths
 # given in html_static_path.
@@ -177,3 +180,18 @@ latex_documents = [
 
 # If false, no module index is generated.
 latex_use_modindex = False
+
+#############################################
+########       END OF CONFIG FILE    ########
+######## DO NOT EDIT BELOW THIS LINE ########
+#############################################
+
+### Performing detect tasks ###
+if auto_rtd:
+    try:
+        import sphinx_rtd_theme
+        del html_style
+        html_theme = "sphinx_rtd_theme"
+        html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+    except:
+        pass

doc/scapy/installation.rst

@@ -497,14 +497,7 @@ To use the ReadTheDocs' template, you will have to install the corresponding the
 
    pip install sphinx_rtd_theme
 
-and edit the doc/scapy/conf.py file to have: ::
-
-   import sphinx_rtd_theme
-   #html_style = 'default.css'
-   html_theme = "sphinx_rtd_theme"
-   html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-
-Note: make sure you commented out the ``html_style`` variable.
+If installed, it will be automatically used, but you may disable it by setting ``auto_rtd`` to ``False`` in ``doc/scapy/conf.py``
 
 UML diagram
 -----------