Functions
	recreate_dir (path)

	generate_and_upload_doxygen ()

Variables
str	DOXYFILE_BASENAME = 'Doxyfile'

str	DOXYGEN_BINARY = 'doxygen'

	WORKDIR = os.path.join(os.pardir, 'doxygen_workdir')

	DOXYGEN_CONFIG_DIR = os.path.join(WORKDIR, 'doxygen-config')

	DOXYGEN_WORKING_DIR = os.path.join(WORKDIR, 'doxygen')

str	DOXYGEN_GS_PATH = '/'.join(['gs://skia-doc', 'doxygen'])

str	IFRAME_FOOTER_TEMPLATE

Detailed Description

Generate Doxygen documentation.

Function Documentation

◆ generate_and_upload_doxygen()

generate_and_upload_doxygen.generate_and_upload_doxygen ( )

Generate Doxygen.

Definition at line 42 of file generate_and_upload_doxygen.py.

def generate_and_upload_doxygen():
  """Generate Doxygen."""
  # Create empty dir and add static_footer.txt
  recreate_dir(DOXYGEN_WORKING_DIR)
  static_footer_path = os.path.join(DOXYGEN_WORKING_DIR, 'static_footer.txt')
  shutil.copyfile(os.path.join('tools', 'doxygen_footer.txt'),
                  static_footer_path)
 
  # Make copy of doxygen config file, overriding any necessary configs,
  # and run doxygen.
  recreate_dir(DOXYGEN_CONFIG_DIR)
  modified_doxyfile = os.path.join(DOXYGEN_CONFIG_DIR, DOXYFILE_BASENAME)
  with open(DOXYFILE_BASENAME, 'r') as reader:
    with open(modified_doxyfile, 'w') as writer:
      shutil.copyfileobj(reader, writer)
      writer.write('OUTPUT_DIRECTORY = %s\n' % DOXYGEN_WORKING_DIR)
      writer.write('HTML_FOOTER = %s\n' % static_footer_path)
  subprocess.check_call([DOXYGEN_BINARY, modified_doxyfile])
 
  # Create iframe_footer.html
  with open(os.path.join(DOXYGEN_WORKING_DIR, 'iframe_footer.html'), 'w') as f:
    f.write(IFRAME_FOOTER_TEMPLATE % (
        datetime.datetime.now().isoformat(' '),
        subprocess.check_output([DOXYGEN_BINARY, '--version']).rstrip()))
 
  # Upload.
  cmd = ['gsutil', 'cp', '-a', 'public-read', '-R',
         DOXYGEN_WORKING_DIR, DOXYGEN_GS_PATH]
  subprocess.check_call(cmd)
 
 

◆ recreate_dir()

generate_and_upload_doxygen.recreate_dir ( path )

Delete and recreate the directory.

Definition at line 32 of file generate_and_upload_doxygen.py.

def recreate_dir(path):
  """Delete and recreate the directory."""
  try:
    shutil.rmtree(path)
  except OSError:
    if os.path.exists(path):
      raise Exception('Could not remove %s' % path)
  os.makedirs(path)
 
 

Variable Documentation

◆ DOXYFILE_BASENAME

str generate_and_upload_doxygen.DOXYFILE_BASENAME = 'Doxyfile'

Definition at line 17 of file generate_and_upload_doxygen.py.

◆ DOXYGEN_BINARY

str generate_and_upload_doxygen.DOXYGEN_BINARY = 'doxygen'

Definition at line 18 of file generate_and_upload_doxygen.py.

◆ DOXYGEN_CONFIG_DIR

generate_and_upload_doxygen.DOXYGEN_CONFIG_DIR = os.path.join(WORKDIR, 'doxygen-config')

Definition at line 20 of file generate_and_upload_doxygen.py.

◆ DOXYGEN_GS_PATH

str generate_and_upload_doxygen.DOXYGEN_GS_PATH = '/'.join(['gs://skia-doc', 'doxygen'])

Definition at line 22 of file generate_and_upload_doxygen.py.

◆ DOXYGEN_WORKING_DIR

generate_and_upload_doxygen.DOXYGEN_WORKING_DIR = os.path.join(WORKDIR, 'doxygen')

Definition at line 21 of file generate_and_upload_doxygen.py.

◆ IFRAME_FOOTER_TEMPLATE

str generate_and_upload_doxygen.IFRAME_FOOTER_TEMPLATE

Initial value:

=  """
<html><body><address style="text-align: right;"><small>
Generated at %s for skia
by <a href="http://www.doxygen.org/index.html">doxygen</a>
%s </small></address></body></html>
"""

Definition at line 24 of file generate_and_upload_doxygen.py.

◆ WORKDIR

generate_and_upload_doxygen.WORKDIR = os.path.join(os.pardir, 'doxygen_workdir')

Definition at line 19 of file generate_and_upload_doxygen.py.

Functions

Variables