Kaynağa Gözat

o3de-doxygen tool - fix issue with Gem APIs not generating, lessen setup steps.

Signed-off-by: chanmosq <[email protected]>
chanmosq 2 yıl önce
ebeveyn
işleme
ccf203d2eb

+ 0 - 27
tools/o3de-doxygen/README.md

@@ -18,31 +18,6 @@ The [Open 3D Engine (O3DE) API Reference](https://www.o3de.org/docs/api/) is gen
 2. In the `tools` directory, find the `o3de-doxygen` scripts.
 2. In the `tools` directory, find the `o3de-doxygen` scripts.
 
 
 
 
-### Install rust commands
-
-The `o3de-doxygen` scripts use some efficient Rust commands for processing the source code in `o3de`. You must install Rust and the `fd-find` cargo to run the scripts properly. 
-
-
-1. Install Rust by using [rustup](https://rustup.rs/), or by running the following command in your Linux machine: 
-
-    ```shell
-    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
-    ```
-
-1. Add rust to your environment variables.
-
-    ```shell
-    source "$HOME/.cargo/env"
-    ```
-
-1. Install the `fd-find` cargo, which is a file searching tool:
-
-    ```shell
-    cargo install fd-find
-    ```
-
-
-
 ### Clean repos
 ### Clean repos
 
 
 The C++ API reference generation scripts run Doxygen on your local `o3de` clone. These scripts output the generated files into your local `o3de.org` clone. Therefore, before you generate the API, you must ensure that your cloned repos are clean and have the latest changes.
 The C++ API reference generation scripts run Doxygen on your local `o3de` clone. These scripts output the generated files into your local `o3de.org` clone. Therefore, before you generate the API, you must ensure that your cloned repos are clean and have the latest changes.
@@ -114,8 +89,6 @@ This generates the following files in `O3DEORG_PATH`:
 
 
 ### Gems API
 ### Gems API
 
 
-*Note: You must [install rust commands](#install-rust-commands) to run `o3de-gem-apis.sh`.*
-
 In the `o3de-doxygen` directory, run the script:
 In the `o3de-doxygen` directory, run the script:
 
 
 ```shell
 ```shell

+ 3 - 3
tools/o3de-doxygen/config.sh

@@ -1,10 +1,10 @@
 #!/bin/bash
 #!/bin/bash
 
 
-# Path to user's local o3de repository  (e.g. $HOME/o3de)
+# Path to user's local o3de repository  (e.g. =$HOME/o3de)
 O3DE_PATH=
 O3DE_PATH=
 
 
-# Path to user's local o3de.org repository (e.g. $HOME/o3de.org)
+# Path to user's local o3de.org repository (e.g. =$HOME/o3de.org)
 O3DEORG_PATH=
 O3DEORG_PATH=
 
 
-# O3DE version number, passed to Doxygen configuration
+# O3DE version number, passed to Doxygen configuration (e.g. =23.05.0)
 PROJECT_NUMBER=
 PROJECT_NUMBER=

+ 2 - 6
tools/o3de-doxygen/o3de-gem-apis.sh

@@ -59,7 +59,7 @@ for gem_path in `ls -1d ${GEMS}/*/`; do
     echo PROJECT_NAME=\"Open 3D Engine ${gem} Gem API Reference\" >> $config_file
     echo PROJECT_NAME=\"Open 3D Engine ${gem} Gem API Reference\" >> $config_file
     echo PROJECT_NUMBER=${PROJECT_NUMBER} >> $config_file
     echo PROJECT_NUMBER=${PROJECT_NUMBER} >> $config_file
     echo OUTPUT_DIRECTORY=${OUTPUT_DIRECTORY} >> $config_file
     echo OUTPUT_DIRECTORY=${OUTPUT_DIRECTORY} >> $config_file
-    echo INPUT=$(fd -t d -X echo {} \; -- Include ${gem_path}) $index >> $config_file
+    echo INPUT=${gem_path} $index >> $config_file
     echo HTML_OUTPUT=${gem} >> $config_file
     echo HTML_OUTPUT=${gem} >> $config_file
     echo STRIP_FROM_PATH=$O3DE_PATH >> $config_file
     echo STRIP_FROM_PATH=$O3DE_PATH >> $config_file
 
 
@@ -69,10 +69,6 @@ for gem_path in `ls -1d ${GEMS}/*/`; do
 
 
     # Post-process generated files
     # Post-process generated files
 
 
-    API_PATH=build/gems/${gem}
-    API_NAME=${gem}
     generate_toc "${OUTPUT_DIRECTORY}/${gem}" "${gem}"
     generate_toc "${OUTPUT_DIRECTORY}/${gem}" "${gem}"
-done
 
 
-## cleanup
-rm ${index}
+done