build_api_docs.py

# Copyright 2020 The qsim Authors. 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.
# ==============================================================================
"""Tool to generate external api_docs for qsim shameless copy from TFQ."""

import os

from absl import app, flags
from tensorflow_docs.api_generator import generate_lib, public_api

import qsimcirq as qs

flags.DEFINE_string("output_dir", "/tmp/qsim_api", "Where to output the docs")

flags.DEFINE_string(
    "code_url_prefix",
    ("https://github.com/quantumlib/qsim/tree/main/qsimcirq"),
    "The url prefix for links to code.",
)

flags.DEFINE_bool(
    "search_hints", True, "Include metadata search hints in the generated files"
)

flags.DEFINE_string(
    "site_path", "/quark/qsim/api_docs/python", "Path prefix in the _toc.yaml"
)

FLAGS = flags.FLAGS


def main(unused_argv):
    doc_generator = generate_lib.DocGenerator(
        root_title="qsim",
        py_modules=[("qsimcirq", qs)],
        base_dir=os.path.dirname(qs.__file__),
        code_url_prefix=FLAGS.code_url_prefix,
        search_hints=FLAGS.search_hints,
        site_path=FLAGS.site_path,
        callbacks=[public_api.local_definitions_filter],
        private_map={
            "qsimcirq": [
                "qsim_circuit",
                "qsimc",
                "qsim_simulator",
                "qsimh_simulator",
            ]
        },
    )

    doc_generator.build(output_dir=FLAGS.output_dir)


if __name__ == "__main__":
    app.run(main)