[ovs-dev] [PATCH 04/14] Add initial sphinx configuration

[Russell Bryant]

On Wed, Nov 30, 2016 at 9:02 PM, Russell Bryant <russell at ovn.org> wrote:

>
>
> On Tue, Nov 22, 2016 at 1:18 PM, Stephen Finucane <stephen at that.guru>
> 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 <stephen at 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.
>> ---
>>  .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.
>

though I should probably change it to be "2.6.90" to match the version
currently used for master.

-- 
Russell Bryant