mirror of
https://github.com/shaka-project/shaka-player.git
synced 2026-06-14 15:56:38 +03:00
Jacob Trimble
fddcf0c259
Rather than using print, use the logging module. This allows embedding environments to setup logging how they want. This also ensures the logs are flushed properly. The prints for check.py, checkversion.py, stats.py, and for the --help flag will still be printed to stdout since that would be the expected output location. Change-Id: I26e1bc866803c42981628c7e62261d13c7b3ff2b
51 lines
1.5 KiB
Python
Executable File
51 lines
1.5 KiB
Python
Executable File
#!/usr/bin/env python
|
|
#
|
|
# Copyright 2016 Google Inc. All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
"""Builds the documentation from the source code.
|
|
|
|
This deletes the old documentation first.
|
|
"""
|
|
|
|
import logging
|
|
import os
|
|
import shutil
|
|
import sys
|
|
|
|
import shakaBuildHelpers
|
|
|
|
|
|
def build_docs(_):
|
|
"""Builds the source code documentation."""
|
|
logging.info('Building the docs...')
|
|
|
|
base = shakaBuildHelpers.get_source_base()
|
|
shutil.rmtree(os.path.join(base, 'docs', 'api'), ignore_errors=True)
|
|
os.chdir(base)
|
|
|
|
if shakaBuildHelpers.is_windows() or shakaBuildHelpers.is_cygwin():
|
|
# Windows has a different command name. The Unix version does not seem to
|
|
# work on Cygwin, but the windows one does.
|
|
jsdoc = os.path.join('third_party', 'jsdoc', 'jsdoc.cmd')
|
|
else:
|
|
jsdoc = os.path.join('third_party', 'jsdoc', 'jsdoc')
|
|
|
|
cmd_line = [jsdoc, '-c', 'docs/jsdoc.conf.json', '-R', 'docs/api-mainpage.md']
|
|
return shakaBuildHelpers.execute_get_code(cmd_line)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
shakaBuildHelpers.run_main(build_docs)
|