-
Notifications
You must be signed in to change notification settings - Fork 0
/
xrst.toml
146 lines (145 loc) · 3.58 KB
/
xrst.toml
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# SPDX-License-Identifier: GPL-3.0-or-later
# SPDX-FileCopyrightText: Bradley M. Bell <[email protected]>
# SPDX-FileContributor: 2020-24 Bradley M. Bell
# -----------------------------------------------------------------------------
# BEGIN_PROJECT_NAME
[project_name]
data = 'xrst'
# END_PROJECT_NAME
# -----------------------------------------------------------------------------
# BEGIN_DIRECTORY
[directory]
# This is same as the default and only used as an example
project_directory = '.'
rst_directory = 'build/rst'
html_directory = 'build/html'
tex_directory = 'build/tex'
# END_DIRECTORY
# -----------------------------------------------------------------------------
# BEGIN_ROOT_FILE
[root_file]
default = 'example/example.xrst'
user = 'user/user.xrst'
dev = 'xrst/__init__.py'
# END_ROOT_FILE
# -----------------------------------------------------------------------------
# BEGIN_HEADING
# If running an old verison of xrst that does not support heading,
# comment out the lines from [heading] to overline =.
[heading]
# level 0, 1, 2, 3, 4,
character = [ '#', '*', '=', '-', '.', ]
overline = [ false, false, false, false, false, ]
# END_HEADING
# -----------------------------------------------------------------------------
# BEGIN_SPELL_PACKAGE
# [spell_package]
# This is commented out because pyenchant is harder to set up on some systems:
# data = 'pyenchant'
# END_SPELL_PACKAGE
# -----------------------------------------------------------------------------
# BEGIN_INPUT_FILES
[input_files]
data = [
[ 'bin/input_files.sh' ] ,
]
# END_INPUT_FILES
# -----------------------------------------------------------------------------
# BEGIN_HTML_THEME_OPTIONS
# This is same as the default and only used as an example
[html_theme_options.sphinx_book_theme]
show_toc_level = 4
[html_theme_options.sphinx_rtd_theme]
navigation_depth = -1
titles_only = true
# END_HTML_THEME_OPTIONS
#
# BEGIN_INCLUDE_ALL
[include_all]
rst_epilog = ''
rst_prolog = '''
.. |space| unicode:: 0xA0
.. |tab| replace:: |space| |space| |space|
'''
latex_macro = [
'\newcommand{\B}[1]{ {\bf #1} }' ,
'\newcommand{\R}[1]{ {\rm #1} }' ,
]
# END_INCLUDE_ALL
# -----------------------------------------------------------------------------
# BEGIN_PROJECT_DICTIONARY
[project_dictionary]
data = [
# keywords in souce code languages
'''
bool
def
dict
int
str
''',
# file extensions
'''
py
rst
toml
''',
# abbreviations
# dir: used for directory (as part of a variable name)
# obj: used for object (as appossed to the corresponding class)
# tmp: is used for temparary values
# toc: used for table of contents or table of children
# dd-mm: used for day and month as two decimal characters
'''
dir
obj
tmp
toc
dd
mm
''',
# special words
'''
boolean
meta
newline
newlines
overline
pyspellchecker
xrst
''',
]
# END_PROJECT_DICTIONARY
# -----------------------------------------------------------------------------
# BEGIN_NOT_IN_INDEX
[not_in_index]
data = [
# articles, prepositions, and common verbs
'''
a
an
and
been
by
for
has
of
that
the
this
to
''',
# words that are use in many different pages of the documentation
'''
command
example
file
purpose
syntax
''',
# python regular expression for month-day used in release notes
'[0-9]{2}-[0-9]{2}',
# python regular expression for year.month.day used in version number
'[0-9]{4}[.][0-9]{1,2}[.][0-9]{1,2}',
]
# END_NOT_IN_INDEX