From 790360f8abc5678dd2b58f3bae312e02407720e0 Mon Sep 17 00:00:00 2001 From: Mattias Ellert Date: Sat, 23 Apr 2022 19:03:05 +0200 Subject: [PATCH] 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 --- bindings/python/docs/source/.templates/layout.html | 2 -- bindings/python/docs/source/conf.py | 4 ++-- bindings/python/docs/source/examples.rst | 3 +-- .../docs/source/{.static/img => }/favicon.ico | Bin bindings/python/docs/source/install.rst | 2 +- .../docs/source/modules/client/copyprocess.rst | 3 ++- bindings/python/docs/source/modules/client/file.rst | 1 + .../python/docs/source/modules/client/responses.rst | 2 +- bindings/python/docs/source/modules/client/url.rst | 3 ++- .../python/docs/source/modules/client/utils.rst | 2 +- .../docs/source/{.static/img => }/xrootd-200x68.png | Bin bindings/python/libs/client/file.py | 4 ++-- 12 files changed, 13 insertions(+), 13 deletions(-) rename bindings/python/docs/source/{.static/img => }/favicon.ico (100%) rename bindings/python/docs/source/{.static/img => }/xrootd-200x68.png (100%) diff --git a/bindings/python/docs/source/.templates/layout.html b/bindings/python/docs/source/.templates/layout.html index 3f5220fafd4..1c7680eef9f 100755 --- 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'%} \ No newline at end of file diff --git a/bindings/python/docs/source/conf.py b/bindings/python/docs/source/conf.py index e907a79eda7..14aa9782860 100644 --- 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 index 66936148e64..9e7d5481442 100644 --- 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 \ No newline at end of file + examples/copyprocess diff --git a/bindings/python/docs/source/.static/img/favicon.ico b/bindings/python/docs/source/favicon.ico similarity index 100% rename from bindings/python/docs/source/.static/img/favicon.ico rename to bindings/python/docs/source/favicon.ico diff --git a/bindings/python/docs/source/install.rst b/bindings/python/docs/source/install.rst index 6cd6b7a4b65..b382321edde 100644 --- a/bindings/python/docs/source/install.rst +++ b/bindings/python/docs/source/install.rst @@ -3,4 +3,4 @@ =========================== .. include:: ../../README.rst - :start-line: 8 \ No newline at end of file + :start-line: 8 diff --git a/bindings/python/docs/source/modules/client/copyprocess.rst b/bindings/python/docs/source/modules/client/copyprocess.rst index 46f7c0cbe7e..f0140498218 100644 --- 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 \ No newline at end of file +.. 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 index 168e9599335..5dd18acb780 100644 --- 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 index 309d698a557..29c30405b99 100644 --- 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() \ No newline at end of file +.. 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 index 8b5168743db..bc5665d61f3 100644 --- a/bindings/python/docs/source/modules/client/url.rst +++ b/bindings/python/docs/source/modules/client/url.rst @@ -6,6 +6,7 @@ Class Reference --------------- .. module:: XRootD.client + :noindex: .. autoclass:: XRootD.client.URL() @@ -13,4 +14,4 @@ Methods ******* .. automethod:: XRootD.client.URL.is_valid -.. automethod:: XRootD.client.URL.clear \ No newline at end of file +.. 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 index 2ef43d36b47..8e086f45d1b 100644 --- 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: \ No newline at end of file + :members: diff --git a/bindings/python/docs/source/.static/img/xrootd-200x68.png b/bindings/python/docs/source/xrootd-200x68.png similarity index 100% rename from bindings/python/docs/source/.static/img/xrootd-200x68.png rename to bindings/python/docs/source/xrootd-200x68.png diff --git a/bindings/python/libs/client/file.py b/bindings/python/libs/client/file.py index d1e024319ba..bff9b429e7f 100644 --- 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