fork/rules_rust
git clone https://git.julia.blue/fork/rules_rust
971ff661
0.8.1
1"""A helper module for generating documentation for rules_rust""" 2 3def page ( name , symbols , header_template = None ): 4"""Define a collection of attributes used to generate a page of documentation 5 6Note, all templates are Velocity files: https://velocity.apache.org/engine/devel/user-guide.html 7 8Args: 9name (str): The name of the page 10symbols (list): A list of symbol names 11header_template (Label, optional): The label of a `header_template` stardoc attribute 12 13Returns: 14tuple: The name of the page with the page content 15""" 16return ( name , struct ( 17name = name , 18header_template = header_template , 19symbols = symbols , 20)) 21 22# buildifier: disable=unnamed-macro 23def gen_header ( page ): 24"""Generate a header with a table of contents 25 26Args: 27page (struct): A `page` struct 28""" 29name = "%s_gen_header_vm" % page . name 30outs = [ "%s_gen_header.vm" % page . name ] 31 32# Set the top level header 33page_names = [ w . capitalize () for w in page . name . split ( "_" )] 34cmd = [ 35"echo '<!-- Generated with Stardoc: http://skydoc.bazel.build -->'" , 36"echo '# {}'" . format ( " " . join ( page_names )), 37"echo ''" , 38] 39 40# Add table of contents 41cmd . extend ([ "echo '* [{rule}](#{rule})'" . format ( rule = s ) for s in page . symbols ]) 42 43# Render an optional header 44if page . header_template : 45cmd . extend ([ 46"echo ''" , 47"cat $(execpath {})" . format ( page . header_template ), 48]) 49srcs = [ page . header_template ] 50else : 51srcs = [] 52 53native . genrule ( 54name = name , 55outs = outs , 56cmd = "{\n " + " \n ".join(cmd) + " \n } > $@", 57srcs = srcs , 58output_to_bindir = True , 59)