diff mbox series

[v3,03/47,DO-NOT-MERGE] docs/sphinx: change default role to "any"

Message ID 20200925002900.465855-4-jsnow@redhat.com
State New
Headers show
Series qapi: static typing conversion, pt1 | expand

Commit Message

John Snow Sept. 25, 2020, 12:28 a.m. UTC
Signed-off-by: John Snow <jsnow@redhat.com>
---
 docs/conf.py | 3 +++
 1 file changed, 3 insertions(+)

Comments

Cleber Rosa Sept. 29, 2020, 3:30 a.m. UTC | #1
On Thu, Sep 24, 2020 at 08:28:16PM -0400, John Snow wrote:
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>  docs/conf.py | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/docs/conf.py b/docs/conf.py
> index 0dbd90dc11..a68f616d5a 100644
> --- a/docs/conf.py
> +++ b/docs/conf.py
> @@ -81,6 +81,9 @@
>  # The master toctree document.
>  master_doc = 'index'
>  
> +# Interpret `this` to be a cross-reference to "anything".
> +default_role = 'any'
> +
>  # General information about the project.
>  project = u'QEMU'
>  copyright = u'2020, The QEMU Project Developers'
> -- 
> 2.26.2
> 

After this I get:

  qemu/docs/cpu-hotplug.rst:81: WARNING: 'any' reference target not found: query-cpus-fast

So I missed it during the review of the first patch ("docs: replace
single backtick (`) with double-backtick (``)").

- Cleber.
John Snow Sept. 29, 2020, 3:33 p.m. UTC | #2
On 9/28/20 11:30 PM, Cleber Rosa wrote:
> On Thu, Sep 24, 2020 at 08:28:16PM -0400, John Snow wrote:
>> Signed-off-by: John Snow <jsnow@redhat.com>
>> ---
>>   docs/conf.py | 3 +++
>>   1 file changed, 3 insertions(+)
>>
>> diff --git a/docs/conf.py b/docs/conf.py
>> index 0dbd90dc11..a68f616d5a 100644
>> --- a/docs/conf.py
>> +++ b/docs/conf.py
>> @@ -81,6 +81,9 @@
>>   # The master toctree document.
>>   master_doc = 'index'
>>   
>> +# Interpret `this` to be a cross-reference to "anything".
>> +default_role = 'any'
>> +
>>   # General information about the project.
>>   project = u'QEMU'
>>   copyright = u'2020, The QEMU Project Developers'
>> -- 
>> 2.26.2
>>
> 
> After this I get:
> 
>    qemu/docs/cpu-hotplug.rst:81: WARNING: 'any' reference target not found: query-cpus-fast
> 
> So I missed it during the review of the first patch ("docs: replace
> single backtick (`) with double-backtick (``)").
> 
> - Cleber.
> 

Not sure why I didn't encounter that. Maybe version troubles again? 
Configuration differences?

--js
John Snow Sept. 29, 2020, 6:20 p.m. UTC | #3
On 9/28/20 11:30 PM, Cleber Rosa wrote:
> On Thu, Sep 24, 2020 at 08:28:16PM -0400, John Snow wrote:
>> Signed-off-by: John Snow <jsnow@redhat.com>
>> ---
>>   docs/conf.py | 3 +++
>>   1 file changed, 3 insertions(+)
>>
>> diff --git a/docs/conf.py b/docs/conf.py
>> index 0dbd90dc11..a68f616d5a 100644
>> --- a/docs/conf.py
>> +++ b/docs/conf.py
>> @@ -81,6 +81,9 @@
>>   # The master toctree document.
>>   master_doc = 'index'
>>   
>> +# Interpret `this` to be a cross-reference to "anything".
>> +default_role = 'any'
>> +
>>   # General information about the project.
>>   project = u'QEMU'
>>   copyright = u'2020, The QEMU Project Developers'
>> -- 
>> 2.26.2
>>
> 
> After this I get:
> 
>    qemu/docs/cpu-hotplug.rst:81: WARNING: 'any' reference target not found: query-cpus-fast
> 
> So I missed it during the review of the first patch ("docs: replace
> single backtick (`) with double-backtick (``)").
> 
> - Cleber.
> 

What are you invoking to get this to fail?

I am typing "make sphinxdocs".

It doesn't look like this document is actually built as part of the 
manual for me.
diff mbox series

Patch

diff --git a/docs/conf.py b/docs/conf.py
index 0dbd90dc11..a68f616d5a 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -81,6 +81,9 @@ 
 # The master toctree document.
 master_doc = 'index'
 
+# Interpret `this` to be a cross-reference to "anything".
+default_role = 'any'
+
 # General information about the project.
 project = u'QEMU'
 copyright = u'2020, The QEMU Project Developers'