ovs/.readthedocs.yaml

# .readthedocs.yaml
# Read the Docs configuration file.
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details.

# Required.
version: 2

# Set the OS, Python version, etc.
build:
  os: ubuntu-22.04
  tools:
    python: "3.12"

# Build documentation in the "Documentation/" directory with Sphinx.
sphinx:
  configuration: Documentation/conf.py
  builder: "dirhtml"

# Build all formats: HTML, PDF, ePub.
formats: all

# Declare the Python requirements.
python:
  install:
  - requirements: Documentation/requirements.txt
readthedocs: Add the configuration file. 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. Add the configuration file to unblock documentation updates. Need to remove the upper restriction on the sphinx version. sphinx 2.0 is very old at this point and pip fails to install it along with other dependencies on the rtd server. Note: Sphinx 2.0 moved from HTML4 to HTML5 renderer and tables no longer have borders by default. That should be addressed via CSS file in the ovs-sphinx-theme. Acked-by: Aaron Conole <aconole@redhat.com> Signed-off-by: Ilya Maximets <i.maximets@ovn.org> 2023-10-23 15:31:48 +02:00			`# .readthedocs.yaml`
			`# Read the Docs configuration file.`
			`# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details.`

			`# Required.`
			`version: 2`

			`# Set the OS, Python version, etc.`
			`build:`
			`os: ubuntu-22.04`
			`tools:`
			`python: "3.12"`

			`# Build documentation in the "Documentation/" directory with Sphinx.`
			`sphinx:`
			`configuration: Documentation/conf.py`
readthedocs: Use dirhtml builder. We used this builder before, but from the project configuration on the website. ReadTheDocs doesn't allow to change it there anymore and it doesn't allow to see the full name of the previously used builder (!!), so I failed to migrate it to the config file. The result is that older link like: https://docs.openvswitch.org/en/latest/howto/dpdk/ Now require .html: https://docs.openvswitch.org/en/latest/howto/dpdk.html Fixing now by switching the builder back. Fixes: e388bd73b70d ("readthedocs: Add the configuration file.") Reported-by: Antonin Bas <abas@vmware.com> Reported-by: David Marchand <david.marchand@redhat.com> Reported-at: https://github.com/openvswitch/ovs-issues/issues/310 Reviewed-by: Antonin Bas <abas@vmware.com> Acked-by: Eelco Chaudron <echaudro@redhat.com> Reviewed-by: David Marchand <david.marchand@redhat.com> Signed-off-by: Ilya Maximets <i.maximets@ovn.org> 2023-10-26 19:55:04 +02:00			`builder: "dirhtml"`
readthedocs: Add the configuration file. 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. Add the configuration file to unblock documentation updates. Need to remove the upper restriction on the sphinx version. sphinx 2.0 is very old at this point and pip fails to install it along with other dependencies on the rtd server. Note: Sphinx 2.0 moved from HTML4 to HTML5 renderer and tables no longer have borders by default. That should be addressed via CSS file in the ovs-sphinx-theme. Acked-by: Aaron Conole <aconole@redhat.com> Signed-off-by: Ilya Maximets <i.maximets@ovn.org> 2023-10-23 15:31:48 +02:00
			`# Build all formats: HTML, PDF, ePub.`
			`formats: all`

			`# Declare the Python requirements.`
			`python:`
			`install:`
			`- requirements: Documentation/requirements.txt`