From 46dae3d9f471468da5890803e80115db246ea6b6 Mon Sep 17 00:00:00 2001 From: Gabi Davar Date: Sat, 28 Dec 2013 15:50:44 +0200 Subject: [PATCH] Fix sphinx warnings --- doc/conf.py | 2 +- doc/index.rst | 1 + html5lib/treewalkers/__init__.py | 28 +++++++++++++++------------- 3 files changed, 17 insertions(+), 14 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 434f21c4..e02218b8 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -126,7 +126,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +#html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. diff --git a/doc/index.rst b/doc/index.rst index ca2e1b96..27104b14 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -8,6 +8,7 @@ Overview :maxdepth: 2 movingparts + modules changes License diff --git a/html5lib/treewalkers/__init__.py b/html5lib/treewalkers/__init__.py index 93f34dbd..21f46b01 100644 --- a/html5lib/treewalkers/__init__.py +++ b/html5lib/treewalkers/__init__.py @@ -21,19 +21,21 @@ def getTreeWalker(treeType, implementation=None, **kwargs): """Get a TreeWalker class for various types of tree with built-in support - treeType - the name of the tree type required (case-insensitive). Supported - values are: - - "dom" - The xml.dom.minidom DOM implementation - "etree" - A generic walker for tree implementations exposing an - elementtree-like interface (known to work with - ElementTree, cElementTree and lxml.etree). - "lxml" - Optimized walker for lxml.etree - "genshi" - a Genshi stream - - implementation - (Currently applies to the "etree" tree type only). A module - implementing the tree type e.g. xml.etree.ElementTree or - cElementTree.""" + Args: + treeType (str): the name of the tree type required (case-insensitive). + Supported values are: + + - "dom": The xml.dom.minidom DOM implementation + - "etree": A generic walker for tree implementations exposing an + elementtree-like interface (known to work with + ElementTree, cElementTree and lxml.etree). + - "lxml": Optimized walker for lxml.etree + - "genshi": a Genshi stream + + Implementation: A module implementing the tree type e.g. + xml.etree.ElementTree or cElementTree (Currently applies to the + "etree" tree type only). + """ treeType = treeType.lower() if treeType not in treeWalkerCache: