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
|
import os
SIGNATURE = 'MAIN'
def define_env(env):
"""
This is the hook for the functions (new form)
"""
# activate trace
chatter = env.start_chatting(SIGNATURE)
env.macros.cwd = os.getcwd()
# use dot notat ion for adding
env.macros.baz = env.macros.fix_url('foo')
@env.macro
def include_file(filename, start_line=0, end_line=None):
"""
Include a file, optionally indicating start_line and end_line
(start counting from 0)
The path is relative to the top directory of the documentation
project.
"""
chatter("Including:", filename)
full_filename = os.path.join(env.project_dir, filename)
with open(full_filename, 'r') as f:
lines = f.readlines()
line_range = lines[start_line:end_line]
return '\n'.join(line_range)
@env.macro
def doc_env():
"Document the environment"
return {name: getattr(env, name)
for name in dir(env) if not
(name.startswith('_') or name.startswith('register'))}
# Optional: a special function for making relative urls point to root
fix_url = env.macros.fix_url
@env.macro
def button(label, url):
"Add a button"
chatter("Display a button:", label, url)
url = fix_url(url)
HTML = """<a class='md-button' href="%s">%s</a>"""
return HTML % (url, label)
env.variables.special_docs_dir = env.variables.config['docs_dir']
def on_pre_page_macros(env):
"Before macros are executed"
footer = "\n##Added Footer (Pre-macro)\nBuild hour is {{ now() }}"
env.markdown += footer
def on_post_page_macros(env):
"After macros were executed"
# This will add a (Markdown or HTML) footer
footer = '\n'.join(
['', '##Added Footer (Post-macro)', 'Name of the page is _%s_' % env.page.title])
env.markdown += footer
def on_post_build(env):
"Post build action"
# activate trace
chatter = env.start_chatting(SIGNATURE)
chatter("This means `on_post_build(env)` works")
|
