On Wed, 2016-11-30 at 21:05 -0500, Russell Bryant wrote:
>
> On Wed, Nov 30, 2016 at 9:02 PM, Russell Bryant <russ...@ovn.org>
> wrote:
> >
> > On Tue, Nov 22, 2016 at 1:18 PM, Stephen Finucane <step...@that.gur
> > u> wrote:
> > > This is essentially the output of 'sphinx-quickstart' but with
> > > the
> > > following changes:
> > >
> > > - Parts of the generated Makefile are merged into the existing
> > > Documentation/automake.mk Makefile
> > > - A license is added to the index.rst file
> > > - The OVS logo is added
> > > - A 'contents' page is added, so we don't need to include a TOC
> > > on the
> > > home page
> > > - The theme is switched to 'bizstyle', which makes better use of
> > > horizontal real estate than the default 'alabaster' theme
> > >
> > > Copyright is assigned to "The Open vSwitch Development
> > > Community".
> > >
> > > Signed-off-by: Stephen Finucane <step...@that.guru>
> > > ---
> > > The dirhtml buildsystem should be used if the output of this is
> > > used
> > > as-is for openvswitch.org. It's basically unusable for offline
> > > development, however.
This point is meaningless now, as we've settled on ReadTheDocs (RTD)
[1] for distribution of docs.
> > > ---
> > > .gitignore | 1 +
> > > Documentation/_static/logo.png | Bin 0 -> 13341 bytes
> > > Documentation/automake.mk | 23 +++
> > > Documentation/conf.py | 338
> > > +++++++++++++++++++++++++++++++++++++++++
> > > Documentation/contents.rst | 31 ++++
> > > Documentation/index.rst | 28 ++++
> > > 6 files changed, 421 insertions(+)
> > > create mode 100644 Documentation/_static/logo.png
> > > create mode 100644 Documentation/conf.py
> > > create mode 100644 Documentation/contents.rst
> > > create mode 100644 Documentation/index.rst
> >
> >
> > > +# The short X.Y version.
> > > +version = u'2.6'
> > > +# The full version, including alpha/beta/rc tags.
> > > +release = u'2.6.0'
> > >
> >
> > We should fill this in automatically based on the version from the
> > build system, at least when generating the docs locally.
> >
> > Can we also have something done automatically when generating docs
> > on readthedocs?
> >
> > In any case, I'm OK making any changes here as a follow up.
To the best of my knowledge, this will be ignored by RTD which does its
own versioning [2]. If that's not the case, I'll submit a patch to fix
that oversight afterwards, based on what other folks do [3].
> though I should probably change it to be "2.6.90" to match the
> version currently used for master.
I wasn't sure how granular we wanted to be here. Having to change the
version for every point release seemed like unnecessary overhead, hence
only using the MAJOR and MINOR numbers. I'm also not even sure if it's
used (see above). Maybe hold off on this until we see what RTD does? :)
One final point: I generated a higher resolution logo.png (without the
naff white background) using the eps file. This looks much better when
using the RTD theme, which I think RTD defaults to. I've attached a
copy so that you might replace the 'logo.png' provided by this patch
before merging (Git doesn't version binary files, so we'd be adding an
extra ~1 MB for no good reason otherwise). I can also resubmit this
patch if you prefer this.
Cheers,
Stephen
[1] http://http://docs.openvswitch.org/en/latest/
[2] https://docs.readthedocs.io/en/latest/versions.html
[3] https://github.com/rpm-software-management/dnf/blob/master/doc/conf
.py#L54-L72
_______________________________________________
dev mailing list
d...@openvswitch.org
https://mail.openvswitch.org/mailman/listinfo/ovs-dev
