diff options
| author | Stephen Finucane <stephen@that.guru> | 2017-04-10 13:12:28 +0100 |
|---|---|---|
| committer | Ben Pfaff <blp@ovn.org> | 2017-04-21 14:15:13 -0700 |
| commit | fd0837a76f4c7613e535a83b7677bf7946ce7b76 (patch) | |
| tree | 1d9d09cf4f06e3359fb7c4cd9f8ca15651e905cd /Documentation/internals | |
| parent | 717dbe617e9e28e51d8f131f88a44ddca7df7a68 (diff) | |
| download | openvswitch-fd0837a76f4c7613e535a83b7677bf7946ce7b76.tar.gz | |
doc: Convert ovs-vlan-test to rST
Let's start with a simple one that lets us focus on setting up most of
the required "infrastructure" for building man pages using Sphinx.
This changes the 'check-htmldocs' target to 'check-docs' as its now
responsible for building man page docs too.
Other than that, hurrah for (mostly) legible syntaxes.
[1] http://www.tldp.org/HOWTO/Man-Page/q2.html
Signed-off-by: Stephen Finucane <stephen@that.guru>
Signed-off-by: Ben Pfaff <blp@ovn.org>
Diffstat (limited to 'Documentation/internals')
| -rw-r--r-- | Documentation/internals/contributing/documentation-style.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/Documentation/internals/contributing/documentation-style.rst b/Documentation/internals/contributing/documentation-style.rst index 0ba5e544f..0e561ec23 100644 --- a/Documentation/internals/contributing/documentation-style.rst +++ b/Documentation/internals/contributing/documentation-style.rst @@ -347,7 +347,8 @@ In addition to the above, man pages have some specific requirements: - The man page must be included in the list of man page documents found in `conf.py`__ -Refer to existing man pages for worked examples. +Refer to existing man pages, such as :doc:`/ref/ovs-vlan-test.8` for a worked +example. __ http://www.sphinx-doc.org/en/stable/domains.html#directive-program __ http://www.sphinx-doc.org/en/stable/domains.html#directive-option |