[PATCH] docs: hwmon: Suppress Sphinx warning

[PATCH] docs: hwmon: Suppress Sphinx warning

[Adam Zerella]

When generating documentation output Sphinx
outputs a warning for not including
the page 'inspur-ipsps1.rst' in 'index.rst'.
Assuming this documentation is useful it
should be included in the index

Signed-off-by: Adam Zerella <adam.zerella@gmail.com>
---
 Documentation/hwmon/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
index 8147c3f218bf..230ad59b462b 100644
--- a/Documentation/hwmon/index.rst
+++ b/Documentation/hwmon/index.rst
@@ -7,6 +7,7 @@ Linux Hardware Monitoring
 
    hwmon-kernel-api
    pmbus-core
+   inspur-ipsps1
    submitting-patches
    sysfs-interface
    userspace-tools
-- 
2.21.0

Re: [PATCH] docs: hwmon: Suppress Sphinx warning

[Jonathan Corbet]

On Sun, 15 Sep 2019 18:27:18 +1000
Adam Zerella <adam.zerella@gmail.com> wrote:

> When generating documentation output Sphinx
> outputs a warning for not including
> the page 'inspur-ipsps1.rst' in 'index.rst'.
> Assuming this documentation is useful it
> should be included in the index
> 
> Signed-off-by: Adam Zerella <adam.zerella@gmail.com>

Thanks for working to improve the docs!  A couple of quick notes...

 - "suppress a warning" is not a particularly helpful subject line.
   Something like "include inspur-ipsps1.rst in the docs build" says a
   lot more about what you're actually doing.

>  Documentation/hwmon/index.rst | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
> index 8147c3f218bf..230ad59b462b 100644
> --- a/Documentation/hwmon/index.rst
> +++ b/Documentation/hwmon/index.rst
> @@ -7,6 +7,7 @@ Linux Hardware Monitoring
>  
>     hwmon-kernel-api
>     pmbus-core
> +   inspur-ipsps1

 - Which tree is this against?  I don't even have that file, and mainline
   doesn't either.  If this is in linux-next, the fix should probably go
   in via the same tree.

>     submitting-patches
>     sysfs-interface
>     userspace-tools

Thanks,

jon

Re: [PATCH] docs: hwmon: Suppress Sphinx warning

[Jean Delvare]

On Sun, 15 Sep 2019 18:27:18 +1000, Adam Zerella wrote:
> When generating documentation output Sphinx
> outputs a warning for not including
> the page 'inspur-ipsps1.rst' in 'index.rst'.
> Assuming this documentation is useful it
> should be included in the index
> 
> Signed-off-by: Adam Zerella <adam.zerella@gmail.com>
> ---
>  Documentation/hwmon/index.rst | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
> index 8147c3f218bf..230ad59b462b 100644
> --- a/Documentation/hwmon/index.rst
> +++ b/Documentation/hwmon/index.rst
> @@ -7,6 +7,7 @@ Linux Hardware Monitoring
>  
>     hwmon-kernel-api
>     pmbus-core
> +   inspur-ipsps1
>     submitting-patches
>     sysfs-interface
>     userspace-tools

I suggest Cc'ing the linux-hwmon mailing list for any documentation
patch touching files under Documentation/hwmon.

-- 
Jean Delvare
SUSE L3 Support