[ovs-dev] [PATCH] doc: Use ovs theme

Stephen Finucane stephen at that.guru
Wed Jan 4 16:38:55 UTC 2017


On Wed, 2017-01-04 at 08:32 -0800, Ben Pfaff wrote:
> On Wed, Jan 04, 2017 at 04:06:26PM +0000, Stephen Finucane wrote:
> > On Wed, 2017-01-04 at 08:00 -0800, Ben Pfaff wrote:
> > > On Wed, Jan 04, 2017 at 09:03:04AM +0000, Stephen Finucane wrote:
> > > > On Tue, 2017-01-03 at 21:33 +0000, Stephen Finucane wrote:
> > > > > The recently published 'ovs' theme [1] copies the styling of
> > > > > the
> > > > > Open
> > > > > vSwitch website. Start using this, with fallbacks for users
> > > > > who
> > > > > do
> > > > > not
> > > > > have the package installed.
> > > > > 
> > > > > This extends support for building docs to users of Sphinx 1.2
> > > > > as
> > > > > the
> > > > > previous theme - bizstyle - was only available in 1.3+.
> > > > 
> > > > Oops - forgot [1].
> > > > 
> > > > [1] https://pypi.python.org/pypi/ovs-sphinx-theme
> > > > 
> > > > Stephen
> > > > 
> > > > > Signed-off-by: Stephen Finucane <stephen at that.guru>
> > > 
> > > Thanks, I added the footnote and pushed this to master.
> > 
> > ...and I've updated the readthedocs.org config to use
> > Documentation/requirements.txt. Looks good to me.
> 
> I've noticed that when I run "make htmldocs", I always get this
> warning:
>         Cannot find 'ovs_sphinx' package. Falling back to default
> theme.
> Is that expected?

Yes, I have a fallback inserted [1] so that people who don't want to
install anything non-apt/dnf packages can still build the docs locally.
You can get rid of this package by installing the requirements locally.

    $ sudo pip install -r Documentation/requirements.txt
    $ make htmldocs

...which is what docs.openvswitch.org does now. The building docs page
[2] should probably be updated to reflect this.

[1] https://github.com/openvswitch/ovs/blob/e25d4af1e690d1091089aefb5b9
fde31825252d4/Documentation/conf.py#L25-L27
[2] http://docs.openvswitch.org/en/latest/intro/install/documentation/


More information about the dev mailing list