Ilya Maximets <[email protected]> writes: > 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 buids 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. > > Signed-off-by: Ilya Maximets <[email protected]> > ---
Looks like it stopped working about a month ago. Good future idea for a bot to monitor this part. Anyway: Acked-by: Aaron Conole <[email protected]> > .readthedocs.yaml | 24 ++++++++++++++++++++++++ > Documentation/requirements.txt | 2 +- > Makefile.am | 1 + > 3 files changed, 26 insertions(+), 1 deletion(-) > create mode 100644 .readthedocs.yaml > > diff --git a/.readthedocs.yaml b/.readthedocs.yaml > new file mode 100644 > index 000000000..e481e64f1 > --- /dev/null > +++ b/.readthedocs.yaml > @@ -0,0 +1,24 @@ > +# .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 > + > +# Build all formats: HTML, PDF, ePub. > +formats: all > + > +# Declare the Python requirements. > +python: > + install: > + - requirements: Documentation/requirements.txt > diff --git a/Documentation/requirements.txt b/Documentation/requirements.txt > index 77130c6e0..77f44bd76 100644 > --- a/Documentation/requirements.txt > +++ b/Documentation/requirements.txt > @@ -1,2 +1,2 @@ > -sphinx>=1.1,<2.0 > +sphinx>=1.1 > ovs_sphinx_theme>=1.0,<1.1 > diff --git a/Makefile.am b/Makefile.am > index 439e2bf6d..94f488d18 100644 > --- a/Makefile.am > +++ b/Makefile.am > @@ -84,6 +84,7 @@ EXTRA_DIST = \ > .cirrus.yml \ > .editorconfig \ > .github/workflows/build-and-test.yml \ > + .readthedocs.yaml \ > appveyor.yml \ > boot.sh \ > poc/builders/Vagrantfile \ _______________________________________________ dev mailing list [email protected] https://mail.openvswitch.org/mailman/listinfo/ovs-dev
