Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade doxygen to fix C API docs build issue #13950

Merged
merged 56 commits into from
Feb 3, 2023
Merged
Changes from all commits
Commits
Show all changes
56 commits
Select commit Hold shift + click to select a range
5b6f915
Update libclang version for building C/C++ API docs
natke Dec 10, 2022
8d92821
Temporarily add a workflow dispatch
natke Dec 10, 2022
b4a8c7f
Fix capidocs (#43)
natke Dec 10, 2022
b5a93cc
Fix libclang-cpp too
natke Dec 10, 2022
8a37764
Fix libclang-cpp again
natke Dec 10, 2022
13d921d
Upgrade doxygen
natke Dec 10, 2022
c7ff6b7
Upgrade doxygen again
natke Dec 10, 2022
0fa6f4e
Upgrade doxygen yet again
natke Dec 10, 2022
14a6f8b
Update Doxygen config
natke Dec 10, 2022
6e16443
Temporarily disable warning as error to test remainder of workflow
natke Dec 10, 2022
44e9439
Add path to upload-pages-artifact
natke Dec 10, 2022
91bd091
Remove doxygen binaries after using
natke Dec 10, 2022
e784893
Build docs with jekyll
natke Dec 12, 2022
55923c9
Debug build
natke Dec 12, 2022
9514b58
Debug build 2
natke Dec 12, 2022
6ffdcb7
Debug build 3
natke Dec 12, 2022
ca49706
Move C API docs into the right output area and clean up unused artifacts
natke Dec 12, 2022
3c46e53
Permission to remove old C API docs
natke Dec 12, 2022
def4d55
Permission to move new api docs
natke Dec 12, 2022
68bbf54
More permissions
natke Dec 12, 2022
e8e25cd
Debug
natke Dec 12, 2022
b206983
More permissions
natke Dec 12, 2022
2347992
Update site dir
natke Dec 12, 2022
51ef621
Update upload pages version
natke Dec 12, 2022
d35f7a9
Remove quotes from artifact upload path
natke Dec 12, 2022
c697261
Re order jekyll generation
natke Dec 12, 2022
3f2006a
Debug
natke Dec 12, 2022
92ce85d
Clean repo after gh-pages checkout
natke Dec 12, 2022
ef7c9ef
Create API docs dir
natke Dec 12, 2022
b1904c2
Upload API artifact before checking out gh-pages
natke Dec 12, 2022
82d187a
Name upload and download artifact actions
natke Dec 12, 2022
c6e4be3
Add params to upload and download artifact
natke Dec 12, 2022
1eb4e35
Create pages.yml
natke Dec 12, 2022
4f9a8af
Add deploy as a separate step
natke Dec 12, 2022
b685b6a
Debug after download artifact
natke Dec 12, 2022
d537985
Correct attribute of download artifact
natke Dec 12, 2022
6eddd9a
Remove debug and add an explicit pages.yml file
natke Dec 12, 2022
ba3f05a
Re set WARN_AS_ERROR to true
natke Dec 12, 2022
d508c7d
Restrict running workflow to files containing C/C++ API sources
natke Dec 13, 2022
357d8b4
Merge branch 'main' of github.com:microsoft/onnxruntime into fix-capi…
natke Dec 13, 2022
150855c
Merge branch 'main' into fix-capidocs
natke Dec 14, 2022
ddb0945
Remove the pages.yml workflow as this should be in the gh-pages branch
natke Dec 15, 2022
4b24a4e
Merge branch 'fix-capidocs' of github.com:natke/onnxruntime into fix-…
natke Dec 15, 2022
37778ed
Revert workflow changes. Keep doxygen upgrade
natke Feb 1, 2023
49fb4b5
Keep set commit ID as part of revert
natke Feb 1, 2023
cc4dbb4
Revert upload artifact
natke Feb 1, 2023
036cadd
Revert job rename
natke Feb 1, 2023
9a3ef72
Temporarily disable treating warnings as errors
natke Feb 1, 2023
bdd62f9
Revert clean gh-pages checkout
natke Feb 1, 2023
d9ed01c
Sdd debug
natke Feb 2, 2023
2343547
Re-enable WARN_AS_ERROR
natke Feb 2, 2023
3e17260
Merge branch 'main' of github.com:microsoft/onnxruntime into fix-capi…
natke Feb 2, 2023
13d8917
Update onnxruntime_c_api.h
RyanUnderhill Feb 2, 2023
d0154d6
Upgrade doxygen to 1.9.6
natke Feb 3, 2023
9f1f0a7
Remove doxygen version from HTML header
natke Feb 3, 2023
8b1f07d
Use unique branch name for API docs PR
natke Feb 3, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions .github/workflows/publish-c-apidocs.yml
Original file line number Diff line number Diff line change
@@ -3,6 +3,10 @@ on:
push:
branches:
- main
paths:
- include/onnxruntime/core/session

workflow_dispatch:

jobs:
publish:
@@ -13,18 +17,18 @@ jobs:
- name: Install doxygen and dependencies
run: |
sudo apt update
sudo apt-get install libclang-9-dev
sudo apt-get install libclang-cpp9
wget https://www.doxygen.nl/files/doxygen-1.9.2.linux.bin.tar.gz
tar xvzf doxygen-1.9.2.linux.bin.tar.gz
sudo apt-get install libclang-dev
sudo apt-get install libclang-cpp14
wget https://www.doxygen.nl/files/doxygen-1.9.6.linux.bin.tar.gz
tar xvzf doxygen-1.9.6.linux.bin.tar.gz
- name: Set commit ID
id: vars
run: echo "::set-output name=sha_short::$(git rev-parse --short HEAD)"
- name: Run doxygen
run: |
mkdir -p build/doxygen
cd docs/c_cxx
../../doxygen-1.9.2/bin/doxygen
../../doxygen-1.9.6/bin/doxygen
- uses: actions/checkout@v2
with:
ref: gh-pages
@@ -36,7 +40,7 @@ jobs:
- name: Create Pull Request
uses: peter-evans/create-pull-request@v3
with:
branch: gh-pages-pr
branch: gh-pages-pr-c-docs
base: gh-pages
title: '[Automated]: Update C/C++ API docs'
commit-message: 'Update C/C++ API docs to commit ${{ steps.vars.outputs.sha_short }}'
49 changes: 0 additions & 49 deletions docs/c_cxx/Doxyfile
Original file line number Diff line number Diff line change
@@ -1654,17 +1654,6 @@ HTML_FORMULA_FORMAT = png

FORMULA_FONTSIZE = 10

# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
# generated for formulas are transparent PNGs. Transparent PNGs are not
# supported properly for IE 6.0, but are supported on all modern browsers.
#
# Note that when changing this option you need to delete any form_*.png files in
# the HTML output directory before the changes have effect.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.

FORMULA_TRANSPARENT = YES

# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
# to create new LaTeX commands to be used in formulas as building blocks. See
# the section "Including formulas" for details.
@@ -2352,15 +2341,6 @@ EXTERNAL_PAGES = YES
# Configuration options related to the dot tool
#---------------------------------------------------------------------------

# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
# NO turns the diagrams off. Note that this option also works with HAVE_DOT
# disabled, but it is recommended to install and use dot, since it yields more
# powerful graphs.
# The default value is: YES.

CLASS_DIAGRAMS = NO

# You can include diagrams made with dia in doxygen documentation. Doxygen will
# then run dia to produce the diagram and insert it in the documentation. The
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
@@ -2393,23 +2373,6 @@ HAVE_DOT = NO

DOT_NUM_THREADS = 0

# When you want a differently looking font in the dot files that doxygen
# generates you can specify the font name using DOT_FONTNAME. You need to make
# sure dot is able to find the font, which can be done by putting it in a
# standard location or by setting the DOTFONTPATH environment variable or by
# setting DOT_FONTPATH to the directory containing the font.
# The default value is: Helvetica.
# This tag requires that the tag HAVE_DOT is set to YES.

DOT_FONTNAME = Helvetica

# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
# dot graphs.
# Minimum value: 4, maximum value: 24, default value: 10.
# This tag requires that the tag HAVE_DOT is set to YES.

DOT_FONTSIZE = 10

# By default doxygen will tell dot to use the default font as specified with
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
# the path where dot can find it using this tag.
@@ -2644,18 +2607,6 @@ DOT_GRAPH_MAX_NODES = 50

MAX_DOT_GRAPH_DEPTH = 0

# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default, because dot on Windows does not seem
# to support this out of the box.
#
# Warning: Depending on the platform used, enabling this option may lead to
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
# read).
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.

DOT_TRANSPARENT = NO

# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2 changes: 1 addition & 1 deletion docs/c_cxx/doxygen-header.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- HTML header for doxygen 1.9.2-->
<!-- HTML header for doxygen -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
5 changes: 3 additions & 2 deletions include/onnxruntime/core/session/onnxruntime_c_api.h
Original file line number Diff line number Diff line change
@@ -3703,7 +3703,6 @@ struct OrtApi {
ORT_API2_STATUS(RegisterCustomOpsUsingFunction, _Inout_ OrtSessionOptions* options,
_In_ const char* registration_func_name);

/// @}
/// \name OrtKernelInfo
/// Custom operator APIs.
/// @{
@@ -3795,6 +3794,7 @@ struct OrtApi {
* of an input during kernel/session creation.
*
* \param[in] info An instance of ::OrtKernelInfo.
* \param[in] index Which input to get the type information for
* \param[out] type_info Pointer set to the resulting ::OrtTypeInfo. Must be freed with OrtApi::ReleaseTypeInfo.
*
* \snippet{doc} snippets.dox OrtStatus Return Value
@@ -3809,6 +3809,7 @@ struct OrtApi {
* of an output during kernel/session creation.
*
* \param[in] info An instance of ::OrtKernelInfo.
* \param[in] index Which input to get the type information for
* \param[out] type_info Pointer set to the resulting ::OrtTypeInfo. Must be freed with OrtApi::ReleaseTypeInfo.
*
* \snippet{doc} snippets.dox OrtStatus Return Value
@@ -3893,7 +3894,7 @@ struct OrtApi {
* If oneDNN is not available, this function will return failure.
*
* \param[in] options
* \param[in] cann_options
* \param[in] dnnl_options
*
* \snippet{doc} snippets.dox OrtStatus Return Value
*