Update the version numbers in the documentation config to reflect 2.7.90
instead of 2.6.0.
This patch also updates the build system to automatically update this file.
conf.py is now a generated file from conf.py.in. We still include conf.py
in the tree because it's needed for the docs to be automatically generated
for docs.openvswitch.org.
Signed-off-by: Russell Bryant <russell@ovn.org>
Acked-by: Stephen Finucane <stephen@that.guru>
Sphinx 1.1.3 on RHEL7 is able to properly build the documentation.
Discovering fixed because 'sphinx-build v1.1.3' doesn't support
'--version' option.
Acked-by: Stephen Finucane <stephen@that.guru>
Signed-off-by: Ilya Maximets <i.maximets@samsung.com>
Signed-off-by: Ben Pfaff <blp@ovn.org>
Current documentation uses syntax highlighting in 'sphinx'
via 'pygments' library. This leads to build failures on the
systems with old version of this library.
In fact that only 'windows.rst' uses highlighting it's a
very simple change. This helps us to avoid build issues
on different systems and allows to remove painful external
dependency.
Signed-off-by: Ilya Maximets <i.maximets@samsung.com>
Signed-off-by: Ben Pfaff <blp@ovn.org>
Build documentation as part of every build. This ensures any syntax
errors are caught early.
In addition, a 'check-docs' target is added to validates all external
links.
The nitpick ('-n') flag is added to ensure all possible warnings are
raised.
Signed-off-by: Stephen Finucane <stephen@that.guru>
[blp@ovn.org folded in changes for --enable-silent-rules]
Signed-off-by: Ben Pfaff <blp@ovn.org>
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+.
[1] https://pypi.python.org/pypi/ovs-sphinx-theme
Signed-off-by: Stephen Finucane <stephen@that.guru>
Signed-off-by: Ben Pfaff <blp@ovn.org>
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 <stephen@that.guru>
Signed-off-by: Ben Pfaff <blp@ovn.org>
