Minor Broxygen improvements, addresses BIT-1098.

- Internals: move type alias table to private static BroType member.

- Sphinx extension: now uses absolute path to bro binary.

- reST ouput formatting: remove "param" from function desriptions
  and change package overview docs so script link+summaries render
  consistently.
This commit is contained in:
Jon Siwek 2013-12-06 09:35:35 -06:00
parent 574018f478
commit dedc39d784
14 changed files with 53 additions and 27 deletions

View file

@ -114,7 +114,12 @@ def build_target(env, target):
import os
import subprocess
bro_cmd = "bro -X {0} broxygen".format(target.config_file)
path_to_bro = env.config.bro_binary
if not path_to_bro:
raise SphinxError("'bro' not set in sphinx config file (path to bro)")
bro_cmd = "{0} -X {1} broxygen".format(path_to_bro, target.config_file)
cwd = os.getcwd()
os.chdir(os.path.dirname(target.config_file))
@ -307,5 +312,6 @@ def setup(app):
global App
App = app
app.add_domain(BroxygenDomain)
app.add_config_value("bro_binary", None, "env")
app.add_config_value("broxygen_cache", None, "env")
app.connect("env-get-outdated", env_get_outdated_hook)