docs: add new top-level docs builder that builds docs for a single chip

This commit is contained in:
Angus Gratton
2019-11-13 11:46:16 +08:00
committed by Angus Gratton
parent 783856d557
commit e6211c7864
133 changed files with 566 additions and 637 deletions

View File

@@ -0,0 +1,18 @@
import os.path
from docutils.parsers.rst import Directive, directives
from docutils.parsers.rst.directives.misc import Include as BaseInclude
from sphinx.util.docutils import SphinxDirective
class IncludeBuildFile(BaseInclude, SphinxDirective):
"""
Like the standard "Include" directive, but relative to the app
build directory
"""
def run(self):
abspath = os.path.join(self.env.config.build_dir, self.arguments[0])
self.arguments[0] = abspath
self.env.note_included(abspath)
return super(IncludeBuildFile, self).run()
def setup(app):
directives.register_directive('include-build-file', IncludeBuildFile)