Fix sphinx doc

WARNING: The config value `html_logo' has type `dict'; expected `str'. /builddir/build/BUILD/xrootd-5.4.2/bindings/python/docs/source/modules/client/file.rst:5: WARNING: duplicate object description of XRootD.client, other instance in modules/client/copyprocess, use :noindex: for one of them /builddir/build/BUILD/xrootd-5.4.2/bindings/python/docs/source/modules/client/filesystem.rst:8: WARNING: duplicate object description of XRootD.client, other instance in modules/client/file, use :noindex: for one of them /builddir/build/BUILD/xrootd-5.4.2/bindings/python/docs/source/modules/client/url.rst:8: WARNING: duplicate object description of XRootD.client, other instance in modules/client/filesystem, use :noindex: for one of them /builddir/build/BUILD/xrootd-5.4.2/bindings/python/docs/source/index.rst:16: WARNING: examples is already assigned section numbers (nested numbered toctree?) /builddir/build/BUILD/xrootd-5.4.2/redhat-linux-build/bindings/python/build/lib.linux-x86_64-3.10/XRootD/client/file.py:docstring of XRootD.client.file.File.close:6: WARNING: unknown keyword: with /builddir/build/BUILD/xrootd-5.4.2/redhat-linux-build/bindings/python/build/lib.linux-x86_64-3.10/XRootD/client/file.py:docstring of XRootD.client.file.File.close:6: WARNING: unknown keyword: with
xrootd · Apr 23, 2022 · 790360f · 790360f
1 parent 1f765a4
commit 790360f
Show file tree

Hide file tree

Showing 12 changed files with 13 additions and 13 deletions.
diff --git a/bindings/python/docs/source/.templates/layout.html b/bindings/python/docs/source/.templates/layout.html
@@ -1,4 +1,2 @@
 {% extends "!layout.html" %}
 {% set css_files = css_files + ['_static/css/custom.css']%}
-{% set logo = 'img/xrootd-200x68.png'%}
-{% set favicon = 'img/favicon.ico?v=2'%}
diff --git a/bindings/python/docs/source/conf.py b/bindings/python/docs/source/conf.py
@@ -111,12 +111,12 @@
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-html_logo = {}
+html_logo = 'xrootd-200x68.png'
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+html_favicon = 'favicon.ico'
 
 # 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,

diff --git a/bindings/python/docs/source/examples.rst b/bindings/python/docs/source/examples.rst
@@ -3,9 +3,8 @@
 ============
 
 .. toctree::
-   :numbered:
    :maxdepth: 2
 
    examples/filesystem
    examples/file
-   examples/copyprocess
+   examples/copyprocess
diff --git a/...ython/docs/source/.static/img/favicon.ico → bindings/python/docs/source/favicon.ico b/...ython/docs/source/.static/img/favicon.ico → bindings/python/docs/source/favicon.ico
diff --git a/bindings/python/docs/source/install.rst b/bindings/python/docs/source/install.rst
@@ -3,4 +3,4 @@
 ===========================
 
 .. include:: ../../README.rst
-   :start-line: 8
+   :start-line: 8
diff --git a/bindings/python/docs/source/modules/client/copyprocess.rst b/bindings/python/docs/source/modules/client/copyprocess.rst
@@ -6,6 +6,7 @@ Class Reference
 ---------------
 
 .. module:: XRootD.client
+   :noindex:
 
 .. autoclass:: XRootD.client.CopyProcess
 
@@ -14,4 +15,4 @@ Methods
 
 .. automethod:: XRootD.client.CopyProcess.add_job
 .. automethod:: XRootD.client.CopyProcess.prepare
-.. automethod:: XRootD.client.CopyProcess.run
+.. automethod:: XRootD.client.CopyProcess.run
diff --git a/bindings/python/docs/source/modules/client/file.rst b/bindings/python/docs/source/modules/client/file.rst
@@ -3,6 +3,7 @@
 ================================================
 
 .. module:: XRootD.client
+   :noindex:
 
 .. autoclass:: XRootD.client.File
 

diff --git a/bindings/python/docs/source/modules/client/responses.rst b/bindings/python/docs/source/modules/client/responses.rst
@@ -18,4 +18,4 @@ requests to an `XRootD` server.
 .. autoclass:: XRootD.client.responses.Location()
 .. autoclass:: XRootD.client.responses.HostList()
 .. autoclass:: XRootD.client.responses.HostInfo()
-.. autoclass:: XRootD.client.responses.ProtocolInfo()
+.. autoclass:: XRootD.client.responses.ProtocolInfo()
diff --git a/bindings/python/docs/source/modules/client/url.rst b/bindings/python/docs/source/modules/client/url.rst
@@ -6,11 +6,12 @@ Class Reference
 ---------------
 
 .. module:: XRootD.client
+   :noindex:
 
 .. autoclass:: XRootD.client.URL()
 
 Methods
 *******
 
 .. automethod:: XRootD.client.URL.is_valid
-.. automethod:: XRootD.client.URL.clear
+.. automethod:: XRootD.client.URL.clear
diff --git a/bindings/python/docs/source/modules/client/utils.rst b/bindings/python/docs/source/modules/client/utils.rst
@@ -8,4 +8,4 @@
    :members:
 
 .. autoclass:: XRootD.client.utils.CopyProgressHandler
-   :members:
+   :members:
diff --git a/...docs/source/.static/img/xrootd-200x68.png → ...ings/python/docs/source/xrootd-200x68.png b/...docs/source/.static/img/xrootd-200x68.png → ...ings/python/docs/source/xrootd-200x68.png
diff --git a/bindings/python/libs/client/file.py b/bindings/python/libs/client/file.py
@@ -76,8 +76,8 @@ def close(self, timeout=0, callback=None):
               object and None
 
     As of Python 2.5, you can avoid having to call this method explicitly if you
-    use the :keyword:`with` statement.  For example, the following code will
-    automatically close *f* when the :keyword:`with` block is exited::
+    use the `with` statement.  For example, the following code will
+    automatically close *f* when the `with` block is exited::
 
       from __future__ import with_statement # This isn't required in Python 2.6