1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
|
# -*- coding: utf-8 -*-
"""
sphinxcontrib.restbuilder
=========================
Sphinx extension to output reST files.
.. moduleauthor:: Freek Dijkstra <freek@macfreek.nl>
:copyright: Copyright 2012-2021 by Freek Dijkstra and contributors.
:license: BSD, see LICENSE.txt for details.
"""
from __future__ import (print_function, unicode_literals, absolute_import)
from sphinx.builders import Builder
from sphinx.writers.text import STDINDENT
from .builders.rst import RstBuilder
from .writers.rst import RstWriter
def setup(app):
app.require_sphinx('1.0')
app.add_builder(RstBuilder)
app.add_config_value('rst_file_suffix', ".rst", False)
"""This is the file name suffix for reST files"""
app.add_config_value('rst_link_suffix', None, False)
"""The is the suffix used in internal links. By default, takes the same value as rst_file_suffix"""
app.add_config_value('rst_file_transform', None, False)
"""Function to translate a docname to a filename. By default, returns docname + rst_file_suffix."""
app.add_config_value('rst_link_transform', None, False)
"""Function to translate a docname to a (partial) URI. By default, returns docname + rst_link_suffix."""
app.add_config_value('rst_indent', STDINDENT, False)
|
