| Message ID | 20231026175507.574054-1-i.maximets@ovn.org |
|---|---|
| State | Accepted |
| Commit | 594d145410c540ceea8acc1fd1a99067439c67b4 |
| Headers | show |
| Series | [ovs-dev] readthedocs: Use dirhtml builder. | expand |
| Context | Check | Description |
|---|---|---|
| ovsrobot/apply-robot | success | apply and check: success |
| ovsrobot/github-robot-_Build_and_Test | success | github build: passed |
| ovsrobot/intel-ovs-compilation | success | test: success |
LGTM For what it’s worth, I can confirm that the following command generates what looks like the correct documentation structure: sphinx-build -a -b dirhtml Documentation/ /tmp/foo From: Ilya Maximets <i.maximets@ovn.org> Date: Thursday, October 26, 2023 at 10:54 AM To: ovs-dev@openvswitch.org <ovs-dev@openvswitch.org> Cc: Ilya Maximets <i.maximets@ovn.org>, Antonin Bas <abas@vmware.com>, David Marchand <david.marchand@redhat.com> Subject: [PATCH] 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://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fdocs.openvswitch.org%2Fen%2Flatest%2Fhowto%2Fdpdk%2F&data=05%7C01%7Cabas%40vmware.com%7C850f232ba01d4a99968b08dbd64c999b%7Cb39138ca3cee4b4aa4d6cd83d9dd62f0%7C0%7C0%7C638339396708370094%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=KbithcqCdrfxvdvLcjGzWKs6NEGPN3byzCFV1CCA%2BDA%3D&reserved=0<https://docs.openvswitch.org/en/latest/howto/dpdk/> Now require .html: https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fdocs.openvswitch.org%2Fen%2Flatest%2Fhowto%2Fdpdk.html&data=05%7C01%7Cabas%40vmware.com%7C850f232ba01d4a99968b08dbd64c999b%7Cb39138ca3cee4b4aa4d6cd83d9dd62f0%7C0%7C0%7C638339396708526405%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=FbNXZ4ESN8UcPYn%2BBY63PX6E5xS5UijNL%2F%2BxPPj5xNQ%3D&reserved=0<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://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fopenvswitch%2Fovs-issues%2Fissues%2F310&data=05%7C01%7Cabas%40vmware.com%7C850f232ba01d4a99968b08dbd64c999b%7Cb39138ca3cee4b4aa4d6cd83d9dd62f0%7C0%7C0%7C638339396708526405%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=w3%2BjSR%2FteyL0V%2BNnGrvjXi4MW7fpzrXFlsIDunzVPUU%3D&reserved=0<https://github.com/openvswitch/ovs-issues/issues/310> Signed-off-by: Ilya Maximets <i.maximets@ovn.org> --- The version of the docs with the change applied can be temporarily seen here: https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Figsilya-ovs.readthedocs.io%2Fen%2Flatest%2F&data=05%7C01%7Cabas%40vmware.com%7C850f232ba01d4a99968b08dbd64c999b%7Cb39138ca3cee4b4aa4d6cd83d9dd62f0%7C0%7C0%7C638339396708526405%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=KxSIAxcb8LdvBe2PrWrT5%2BSKyJFrNEzaMJou7R4Op2s%3D&reserved=0<https://igsilya-ovs.readthedocs.io/en/latest/> .readthedocs.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e481e64f1..7d505150e 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -14,6 +14,7 @@ build: # Build documentation in the "Documentation/" directory with Sphinx. sphinx: configuration: Documentation/conf.py + builder: "dirhtml" # Build all formats: HTML, PDF, ePub. formats: all -- 2.41.0
On 26 Oct 2023, at 19:55, Ilya Maximets wrote: > 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 > Signed-off-by: Ilya Maximets <i.maximets@ovn.org> The changes look good to me. Verified your generated document and generated a set locally. Acked-by: Eelco Chaudron <echaudro@redhat.com>
On Thu, Oct 26, 2023 at 7:54 PM Ilya Maximets <i.maximets@ovn.org> wrote: > > 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 > Signed-off-by: Ilya Maximets <i.maximets@ovn.org> > --- > > The version of the docs with the change applied can be > temporarily seen here: > https://igsilya-ovs.readthedocs.io/en/latest/ > > .readthedocs.yaml | 1 + > 1 file changed, 1 insertion(+) > > diff --git a/.readthedocs.yaml b/.readthedocs.yaml > index e481e64f1..7d505150e 100644 > --- a/.readthedocs.yaml > +++ b/.readthedocs.yaml > @@ -14,6 +14,7 @@ build: > # Build documentation in the "Documentation/" directory with Sphinx. > sphinx: > configuration: Documentation/conf.py > + builder: "dirhtml" > > # Build all formats: HTML, PDF, ePub. > formats: all > -- > 2.41.0 > Reviewed-by: David Marchand <david.marchand@redhat.com>
On 10/27/23 11:04, David Marchand wrote: > On Thu, Oct 26, 2023 at 7:54 PM Ilya Maximets <i.maximets@ovn.org> wrote: >> >> 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 >> Signed-off-by: Ilya Maximets <i.maximets@ovn.org> >> --- >> >> The version of the docs with the change applied can be >> temporarily seen here: >> https://igsilya-ovs.readthedocs.io/en/latest/ >> >> .readthedocs.yaml | 1 + >> 1 file changed, 1 insertion(+) >> >> diff --git a/.readthedocs.yaml b/.readthedocs.yaml >> index e481e64f1..7d505150e 100644 >> --- a/.readthedocs.yaml >> +++ b/.readthedocs.yaml >> @@ -14,6 +14,7 @@ build: >> # Build documentation in the "Documentation/" directory with Sphinx. >> sphinx: >> configuration: Documentation/conf.py >> + builder: "dirhtml" >> >> # Build all formats: HTML, PDF, ePub. >> formats: all >> -- >> 2.41.0 >> > > Reviewed-by: David Marchand <david.marchand@redhat.com> Thanks, Antonin, Eelco and David! Applied to master and 3.2. Best regards, Ilya Maximets.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e481e64f1..7d505150e 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -14,6 +14,7 @@ build: # Build documentation in the "Documentation/" directory with Sphinx. sphinx: configuration: Documentation/conf.py + builder: "dirhtml" # Build all formats: HTML, PDF, ePub. formats: all
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 Signed-off-by: Ilya Maximets <i.maximets@ovn.org> --- The version of the docs with the change applied can be temporarily seen here: https://igsilya-ovs.readthedocs.io/en/latest/ .readthedocs.yaml | 1 + 1 file changed, 1 insertion(+)