66d394be2b
* Added docstrings for all drivers * Added sphinx extension for generation of docs for drivers. Change-Id: I7b8dfb21f9324b413174c910384b9ae8f458a8d2
40 lines
1.4 KiB
Python
40 lines
1.4 KiB
Python
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
# implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
from docutils import frontend
|
|
from docutils import nodes
|
|
from docutils.parsers import rst
|
|
from docutils import utils
|
|
|
|
|
|
def parse_text(text):
|
|
parser = rst.Parser()
|
|
settings = frontend.OptionParser(
|
|
components=(rst.Parser,)).get_default_values()
|
|
document = utils.new_document(text, settings)
|
|
parser.parse(text, document)
|
|
return document.children
|
|
|
|
|
|
paragraph = lambda text: parse_text(text)[0]
|
|
note = lambda msg: nodes.note("", paragraph(msg))
|
|
hint = lambda msg: nodes.hint("", *parse_text(msg))
|
|
warning = lambda msg: nodes.warning("", paragraph(msg))
|
|
category = lambda title: parse_text("%s\n%s" % (title, "-" * len(title)))[0]
|
|
subcategory = lambda title: parse_text("%s\n%s" % (title, "~" * len(title)))[0]
|
|
section = lambda title: parse_text("%s\n%s" % (title, "\"" * len(title)))[0]
|
|
|
|
|
|
def rstlist(items):
|
|
return parse_text("".join("* %s\n" % item for item in items))
|