| Message ID | 20231102161527.385815-3-i.maximets@ovn.org |
|---|---|
| State | Superseded |
| Headers | show |
| Series | Documentation: Fix the Read The Docs build. | expand |
| Context | Check | Description |
|---|---|---|
| ovsrobot/apply-robot | success | apply and check: success |
| ovsrobot/github-robot-_Build_and_Test | success | github build: passed |
| ovsrobot/github-robot-_ovn-kubernetes | success | github build: passed |
Thank you Ilya, Acked-by: Mark Michelson <mmichels@redhat.com> On 11/2/23 12:15, 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. > > Add the configuration file to unblock documentation updates. > > Signed-off-by: Ilya Maximets <i.maximets@ovn.org> > --- > .readthedocs.yaml | 26 ++++++++++++++++++++++++++ > Makefile.am | 1 + > 2 files changed, 27 insertions(+) > create mode 100644 .readthedocs.yaml > > diff --git a/.readthedocs.yaml b/.readthedocs.yaml > new file mode 100644 > index 000000000..8c451663a > --- /dev/null > +++ b/.readthedocs.yaml > @@ -0,0 +1,26 @@ > +# .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 > + # Default HTML builder. > + builder: "html" > + > +# Build all formats: HTML, PDF, ePub. > +formats: all > + > +# Declare the Python requirements. > +python: > + install: > + - requirements: Documentation/requirements.txt > diff --git a/Makefile.am b/Makefile.am > index 06045760a..98bbb9a1f 100644 > --- a/Makefile.am > +++ b/Makefile.am > @@ -100,6 +100,7 @@ EXTRA_DIST = \ > .github/workflows/test.yml \ > .github/workflows/ovn-kubernetes.yml \ > .github/workflows/ovn-fake-multinode-tests.yml \ > + .readthedocs.yaml \ > boot.sh \ > $(MAN_FRAGMENTS) \ > $(MAN_ROOTS) \
diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..8c451663a --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,26 @@ +# .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 + # Default HTML builder. + builder: "html" + +# Build all formats: HTML, PDF, ePub. +formats: all + +# Declare the Python requirements. +python: + install: + - requirements: Documentation/requirements.txt diff --git a/Makefile.am b/Makefile.am index 06045760a..98bbb9a1f 100644 --- a/Makefile.am +++ b/Makefile.am @@ -100,6 +100,7 @@ EXTRA_DIST = \ .github/workflows/test.yml \ .github/workflows/ovn-kubernetes.yml \ .github/workflows/ovn-fake-multinode-tests.yml \ + .readthedocs.yaml \ boot.sh \ $(MAN_FRAGMENTS) \ $(MAN_ROOTS) \
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. Signed-off-by: Ilya Maximets <i.maximets@ovn.org> --- .readthedocs.yaml | 26 ++++++++++++++++++++++++++ Makefile.am | 1 + 2 files changed, 27 insertions(+) create mode 100644 .readthedocs.yaml