Documentation¶
Integrate Sphinx documentation pages.
Configuration¶
Configuration of documentation module.
from __future__ import unicode_literals
Configuration
DOCUMENTATION_PACKAGE | Define documentation package name.
Default: invenio_docs |
DOCUMENTATION_INDEX | Define default page. Default: index |
Views¶
Documentation Flask Blueprint.
-
class
invenio.modules.documentation.views.
DocsBlueprint
(name, import_name, static_folder=None, static_url_path=None, template_folder=None, url_prefix=None, subdomain=None, url_defaults=None)¶ Wrap blueprint with Sphinx
WebSupport
.-
documentation_package
¶ Return documentation package.
-
send_static_file
(filename)¶ Return static file.
-
support
¶ Return an instance of Sphinx
WebSupport
.
-
-
invenio.modules.documentation.views.
index
(docname=None)¶ Render documentation page.