[libshortfin] Enable building docs with Sphinx #209
Conversation
| @@ -0,0 +1,36 @@ | |||
| # Configuration file for the Sphinx documentation builder. | |||
There was a problem hiding this comment.
add license/copyright header?
There was a problem hiding this comment.
Added a copyright header to the files.
There was a problem hiding this comment.
Can they use the standard format? https://github.com/nod-ai/SHARK-Platform/blob/19834ee1e1d476a116679afb9521ea0cccdeb308/shortfin/shortfin/framework/session.py#L1-L5
# Copyright 2024 Advanced Micro Devices, Inc.
#
# Licensed under the Apache License v2.0 with LLVM Exceptions.
# See https://llvm.org/LICENSE.txt for license information.
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
| # -- Options for HTML output ------------------------------------------------- | ||
| # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output | ||
|
|
||
| html_theme = "sphinx_rtd_theme" |
There was a problem hiding this comment.
Did you try other themes? Wonder if there is something that AMD recommends
https://rocm.docs.amd.com/en/latest/contribute/toolchain.html points to https://sphinx-book-theme.readthedocs.io/en/latest/
There was a problem hiding this comment.
No not yet. I wasn't able to figure out if there is some common theme used and that's at least in line with the IREE Python API docs.
marbre
force-pushed
the
libshortfin-sphinx
branch
2 times, most recently
from
012a9ac
to
852df14
Compare
| @@ -0,0 +1,36 @@ | |||
| # Configuration file for the Sphinx documentation builder. | |||
There was a problem hiding this comment.
Can they use the standard format? https://github.com/nod-ai/SHARK-Platform/blob/19834ee1e1d476a116679afb9521ea0cccdeb308/shortfin/shortfin/framework/session.py#L1-L5
# Copyright 2024 Advanced Micro Devices, Inc.
#
# Licensed under the Apache License v2.0 with LLVM Exceptions.
# See https://llvm.org/LICENSE.txt for license information.
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
852df14
to
3325ac5
Compare
No description provided.