mbox series

[ovs-dev,v2,0/2] Documentation: Fix the Read The Docs build.

Message ID 20231113163212.737909-1-i.maximets@ovn.org
Headers show
Series Documentation: Fix the Read The Docs build. | expand

Message

Ilya Maximets Nov. 13, 2023, 4:30 p.m. UTC
Since last month ReadTheDocs only supports building with a new
configuration file provided in the repository itself:
  https://blog.readthedocs.com/migrate-configuration-v2/

So, all our documentation builds are failing for quite some time.

Also, the use of ovs-sphinx-theme is a little weird.


Temporary version of the docs with these changes is available here:
  https://igsilya-ovn.readthedocs.io/en/latest/

Will also need to go to at least the latest stable branch, because
RTD is using the latest tag for a 'stable' documentation.


Version 2:
  * Replaced the import with importlib.util.find_spec(). [Mark]
  * Added an Ack to the second patch.


Ilya Maximets (2):
  Documentation: Use theme from Read The Docs.
  readthedocs: Add the configuration file.

 .readthedocs.yaml                         | 26 +++++++++++++++++++++++
 Documentation/conf.py                     | 22 ++++++-------------
 Documentation/internals/documentation.rst | 18 ++++++----------
 Documentation/requirements.txt            |  4 ++--
 Makefile.am                               |  1 +
 5 files changed, 43 insertions(+), 28 deletions(-)
 create mode 100644 .readthedocs.yaml

Comments

Dumitru Ceara Nov. 13, 2023, 10:12 p.m. UTC | #1
On 11/13/23 17:30, Ilya Maximets wrote:
> Since last month ReadTheDocs only supports building with a new
> configuration file provided in the repository itself:
>   https://blog.readthedocs.com/migrate-configuration-v2/
> 
> So, all our documentation builds are failing for quite some time.
> 
> Also, the use of ovs-sphinx-theme is a little weird.
> 
> 
> Temporary version of the docs with these changes is available here:
>   https://igsilya-ovn.readthedocs.io/en/latest/
> 
> Will also need to go to at least the latest stable branch, because
> RTD is using the latest tag for a 'stable' documentation.
> 
> 
> Version 2:
>   * Replaced the import with importlib.util.find_spec(). [Mark]
>   * Added an Ack to the second patch.
> 
> 
> Ilya Maximets (2):
>   Documentation: Use theme from Read The Docs.
>   readthedocs: Add the configuration file.
> 

Thanks for fixing the docs, Ilya!  The changes look good to me.  I'll
wait for Mark to re-review, so if he doesn't apply the patches before me
then, for the series:

Acked-by: Dumitru Ceara <dceara@redhat.com>

Ilya, do you plan to add a follow up patch to add a build badge like you
did for OVS?

Regards,
Dumitru
Ilya Maximets Nov. 14, 2023, 10:35 a.m. UTC | #2
On 11/13/23 23:12, Dumitru Ceara wrote:
> On 11/13/23 17:30, Ilya Maximets wrote:
>> Since last month ReadTheDocs only supports building with a new
>> configuration file provided in the repository itself:
>>   https://blog.readthedocs.com/migrate-configuration-v2/
>>
>> So, all our documentation builds are failing for quite some time.
>>
>> Also, the use of ovs-sphinx-theme is a little weird.
>>
>>
>> Temporary version of the docs with these changes is available here:
>>   https://igsilya-ovn.readthedocs.io/en/latest/
>>
>> Will also need to go to at least the latest stable branch, because
>> RTD is using the latest tag for a 'stable' documentation.
>>
>>
>> Version 2:
>>   * Replaced the import with importlib.util.find_spec(). [Mark]
>>   * Added an Ack to the second patch.
>>
>>
>> Ilya Maximets (2):
>>   Documentation: Use theme from Read The Docs.
>>   readthedocs: Add the configuration file.
>>
> 
> Thanks for fixing the docs, Ilya!  The changes look good to me.  I'll
> wait for Mark to re-review, so if he doesn't apply the patches before me
> then, for the series:
> 
> Acked-by: Dumitru Ceara <dceara@redhat.com>
> 
> Ilya, do you plan to add a follow up patch to add a build badge like you
> did for OVS?

Sure.  I can send one separately.

Best regards, Ilya Maximets.
Mark Michelson Nov. 14, 2023, 9:10 p.m. UTC | #3
On 11/13/23 17:12, Dumitru Ceara wrote:
> On 11/13/23 17:30, Ilya Maximets wrote:
>> Since last month ReadTheDocs only supports building with a new
>> configuration file provided in the repository itself:
>>    https://blog.readthedocs.com/migrate-configuration-v2/
>>
>> So, all our documentation builds are failing for quite some time.
>>
>> Also, the use of ovs-sphinx-theme is a little weird.
>>
>>
>> Temporary version of the docs with these changes is available here:
>>    https://igsilya-ovn.readthedocs.io/en/latest/
>>
>> Will also need to go to at least the latest stable branch, because
>> RTD is using the latest tag for a 'stable' documentation.
>>
>>
>> Version 2:
>>    * Replaced the import with importlib.util.find_spec(). [Mark]
>>    * Added an Ack to the second patch.
>>
>>
>> Ilya Maximets (2):
>>    Documentation: Use theme from Read The Docs.
>>    readthedocs: Add the configuration file.
>>
> 
> Thanks for fixing the docs, Ilya!  The changes look good to me.  I'll
> wait for Mark to re-review, so if he doesn't apply the patches before me
> then, for the series:
> 
> Acked-by: Dumitru Ceara <dceara@redhat.com>
> 
> Ilya, do you plan to add a follow up patch to add a build badge like you
> did for OVS?
> 
> Regards,
> Dumitru
> 

Thanks for v2 Ilya.

Acked-by: Mark Michelson <mmichels@redhat.com>
Dumitru Ceara Nov. 15, 2023, 2:06 p.m. UTC | #4
On 11/14/23 22:10, Mark Michelson wrote:
> On 11/13/23 17:12, Dumitru Ceara wrote:
>> On 11/13/23 17:30, Ilya Maximets wrote:
>>> Since last month ReadTheDocs only supports building with a new
>>> configuration file provided in the repository itself:
>>>    https://blog.readthedocs.com/migrate-configuration-v2/
>>>
>>> So, all our documentation builds are failing for quite some time.
>>>
>>> Also, the use of ovs-sphinx-theme is a little weird.
>>>
>>>
>>> Temporary version of the docs with these changes is available here:
>>>    https://igsilya-ovn.readthedocs.io/en/latest/
>>>
>>> Will also need to go to at least the latest stable branch, because
>>> RTD is using the latest tag for a 'stable' documentation.
>>>
>>>
>>> Version 2:
>>>    * Replaced the import with importlib.util.find_spec(). [Mark]
>>>    * Added an Ack to the second patch.
>>>
>>>
>>> Ilya Maximets (2):
>>>    Documentation: Use theme from Read The Docs.
>>>    readthedocs: Add the configuration file.
>>>
>>
>> Thanks for fixing the docs, Ilya!  The changes look good to me.  I'll
>> wait for Mark to re-review, so if he doesn't apply the patches before me
>> then, for the series:
>>
>> Acked-by: Dumitru Ceara <dceara@redhat.com>
>>
>> Ilya, do you plan to add a follow up patch to add a build badge like you
>> did for OVS?
>>
>> Regards,
>> Dumitru
>>
> 
> Thanks for v2 Ilya.
> 
> Acked-by: Mark Michelson <mmichels@redhat.com>
> 

Applied to main, thanks!
Ilya Maximets Nov. 15, 2023, 2:19 p.m. UTC | #5
On 11/15/23 15:06, Dumitru Ceara wrote:
> On 11/14/23 22:10, Mark Michelson wrote:
>> On 11/13/23 17:12, Dumitru Ceara wrote:
>>> On 11/13/23 17:30, Ilya Maximets wrote:
>>>> Since last month ReadTheDocs only supports building with a new
>>>> configuration file provided in the repository itself:
>>>>    https://blog.readthedocs.com/migrate-configuration-v2/
>>>>
>>>> So, all our documentation builds are failing for quite some time.
>>>>
>>>> Also, the use of ovs-sphinx-theme is a little weird.
>>>>
>>>>
>>>> Temporary version of the docs with these changes is available here:
>>>>    https://igsilya-ovn.readthedocs.io/en/latest/
>>>>
>>>> Will also need to go to at least the latest stable branch, because
>>>> RTD is using the latest tag for a 'stable' documentation.
>>>>
>>>>
>>>> Version 2:
>>>>    * Replaced the import with importlib.util.find_spec(). [Mark]
>>>>    * Added an Ack to the second patch.
>>>>
>>>>
>>>> Ilya Maximets (2):
>>>>    Documentation: Use theme from Read The Docs.
>>>>    readthedocs: Add the configuration file.
>>>>
>>>
>>> Thanks for fixing the docs, Ilya!  The changes look good to me.  I'll
>>> wait for Mark to re-review, so if he doesn't apply the patches before me
>>> then, for the series:
>>>
>>> Acked-by: Dumitru Ceara <dceara@redhat.com>
>>>
>>> Ilya, do you plan to add a follow up patch to add a build badge like you
>>> did for OVS?
>>>
>>> Regards,
>>> Dumitru
>>>
>>
>> Thanks for v2 Ilya.
>>
>> Acked-by: Mark Michelson <mmichels@redhat.com>
>>
> 
> Applied to main, thanks!
> 

Thanks!  This should also go to branch-23.09, because RTD builds
'stable' documentation from the latest tag that will be on that
branch.

Best regards, Ilya Maximets.
Dumitru Ceara Nov. 15, 2023, 2:37 p.m. UTC | #6
On 11/15/23 15:19, Ilya Maximets wrote:
> On 11/15/23 15:06, Dumitru Ceara wrote:
>> On 11/14/23 22:10, Mark Michelson wrote:
>>> On 11/13/23 17:12, Dumitru Ceara wrote:
>>>> On 11/13/23 17:30, Ilya Maximets wrote:
>>>>> Since last month ReadTheDocs only supports building with a new
>>>>> configuration file provided in the repository itself:
>>>>>    https://blog.readthedocs.com/migrate-configuration-v2/
>>>>>
>>>>> So, all our documentation builds are failing for quite some time.
>>>>>
>>>>> Also, the use of ovs-sphinx-theme is a little weird.
>>>>>
>>>>>
>>>>> Temporary version of the docs with these changes is available here:
>>>>>    https://igsilya-ovn.readthedocs.io/en/latest/
>>>>>
>>>>> Will also need to go to at least the latest stable branch, because
>>>>> RTD is using the latest tag for a 'stable' documentation.
>>>>>
>>>>>
>>>>> Version 2:
>>>>>    * Replaced the import with importlib.util.find_spec(). [Mark]
>>>>>    * Added an Ack to the second patch.
>>>>>
>>>>>
>>>>> Ilya Maximets (2):
>>>>>    Documentation: Use theme from Read The Docs.
>>>>>    readthedocs: Add the configuration file.
>>>>>
>>>>
>>>> Thanks for fixing the docs, Ilya!  The changes look good to me.  I'll
>>>> wait for Mark to re-review, so if he doesn't apply the patches before me
>>>> then, for the series:
>>>>
>>>> Acked-by: Dumitru Ceara <dceara@redhat.com>
>>>>
>>>> Ilya, do you plan to add a follow up patch to add a build badge like you
>>>> did for OVS?
>>>>
>>>> Regards,
>>>> Dumitru
>>>>
>>>
>>> Thanks for v2 Ilya.
>>>
>>> Acked-by: Mark Michelson <mmichels@redhat.com>
>>>
>>
>> Applied to main, thanks!
>>
> 
> Thanks!  This should also go to branch-23.09, because RTD builds
> 'stable' documentation from the latest tag that will be on that
> branch.
> 

Done, it's now on 23.09 as well.

Regards,
Dumitru