| Message ID | 20231023135947.211574-1-i.maximets@ovn.org |
|---|---|
| State | Accepted |
| Commit | cc89bf8e22f838e08f3729c25384d38cfa17fdb1 |
| Headers | show |
| Series | [ovs-dev] README: Add documentation build status badge. | 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 |
Ilya Maximets <i.maximets@ovn.org> writes: > This should make it a little more visible that documentation > build fails on ReadTheDocs. > > Signed-off-by: Ilya Maximets <i.maximets@ovn.org> > --- NEAT! I guess without the other readthedocs patch the badge will show failure. But it does add a way to monitor the docs build. Acked-by: Aaron Conole <aconole@redhat.com> > README.rst | 2 ++ > 1 file changed, 2 insertions(+) > > diff --git a/README.rst b/README.rst > index e6c0d3d30..a2c234f4d 100644 > --- a/README.rst > +++ b/README.rst > @@ -12,6 +12,8 @@ Open vSwitch > :target: https://ci.appveyor.com/project/blp/ovs/history > .. image:: https://api.cirrus-ci.com/github/openvswitch/ovs.svg > :target: https://cirrus-ci.com/github/openvswitch/ovs > +.. image:: https://readthedocs.org/projects/openvswitch/badge/?version=latest > + :target: https://docs.openvswitch.org/en/latest/ > > What is Open vSwitch? > ---------------------
On 10/25/23 15:22, Aaron Conole wrote: > Ilya Maximets <i.maximets@ovn.org> writes: > >> This should make it a little more visible that documentation >> build fails on ReadTheDocs. >> >> Signed-off-by: Ilya Maximets <i.maximets@ovn.org> >> --- > > NEAT! I guess without the other readthedocs patch the badge will show > failure. But it does add a way to monitor the docs build. > > Acked-by: Aaron Conole <aconole@redhat.com> Thanks! Applied. And it's already green. :) Best regards, Ilya Maximets. > >> README.rst | 2 ++ >> 1 file changed, 2 insertions(+) >> >> diff --git a/README.rst b/README.rst >> index e6c0d3d30..a2c234f4d 100644 >> --- a/README.rst >> +++ b/README.rst >> @@ -12,6 +12,8 @@ Open vSwitch >> :target: https://ci.appveyor.com/project/blp/ovs/history >> .. image:: https://api.cirrus-ci.com/github/openvswitch/ovs.svg >> :target: https://cirrus-ci.com/github/openvswitch/ovs >> +.. image:: https://readthedocs.org/projects/openvswitch/badge/?version=latest >> + :target: https://docs.openvswitch.org/en/latest/ >> >> What is Open vSwitch? >> --------------------- >
diff --git a/README.rst b/README.rst index e6c0d3d30..a2c234f4d 100644 --- a/README.rst +++ b/README.rst @@ -12,6 +12,8 @@ Open vSwitch :target: https://ci.appveyor.com/project/blp/ovs/history .. image:: https://api.cirrus-ci.com/github/openvswitch/ovs.svg :target: https://cirrus-ci.com/github/openvswitch/ovs +.. image:: https://readthedocs.org/projects/openvswitch/badge/?version=latest + :target: https://docs.openvswitch.org/en/latest/ What is Open vSwitch? ---------------------
This should make it a little more visible that documentation build fails on ReadTheDocs. Signed-off-by: Ilya Maximets <i.maximets@ovn.org> --- README.rst | 2 ++ 1 file changed, 2 insertions(+)