Update: Documents

nutti · Dec 11, 2023 · 24a6a04 · 24a6a04
1 parent 9758655
commit 24a6a04
Show file tree

Hide file tree

Showing 9 changed files with 15 additions and 6 deletions.
diff --git a/BlueprintToRSTDoc/Resources/Button_40x.png b/BlueprintToRSTDoc/Resources/Button_40x.png
diff --git a/BlueprintToRSTDoc/Resources/Icon128.png b/BlueprintToRSTDoc/Resources/Icon128.png
diff --git a/BlueprintToRSTDoc/Source/BlueprintToRSTDoc/Private/BPLibrary.cpp b/BlueprintToRSTDoc/Source/BlueprintToRSTDoc/Private/BPLibrary.cpp
@@ -1323,4 +1323,6 @@ void UBlueprintToRSTDocBPLibrary::GenerateRSTDoc(const FString& OutputDirectory,
 			return;
 		}
 	}
+
+	bSuccess = true;
 }
diff --git a/README.md b/README.md
@@ -5,6 +5,10 @@ from Blueprints.
 
 ![Thumbnail](docs/images/thumbnail.png)
 
+## Features
+
+* Genereate reStructuredText (RST) documents from Blueprints.
+
 ## Supported Environment
 
 * Unreal Engine Version: 4.25-4.27, 5.0-

diff --git a/docs/images/thumbnail.png b/docs/images/thumbnail.png
diff --git a/docs/images/tutorial/generate_documents.png b/docs/images/tutorial/generate_documents.png
diff --git a/docs/images/tutorial/plugin_configuration.png b/docs/images/tutorial/plugin_configuration.png
diff --git a/docs/images/tutorial/process_2.png b/docs/images/tutorial/process_2.png
diff --git a/docs/tutorial.md b/docs/tutorial.md
@@ -2,6 +2,8 @@
 
 ## 1. Configure documents generation settings
 
+![Plugin Configuration](images/tutorial/plugin_configuration.png)
+
 The configuration for this plugin is available on *Settings* >
 *Project Settings...* > *Plugins* > *BlueprintToRSTDoc*.
 
@@ -25,14 +27,15 @@ The configuration for this plugin is available on *Settings* >
 
 ## 2. Generate documents
 
-![Tutorial Process 2](images/tutorial/process_2.png)
+![Generate Documents](images/tutorial/generate_documents.png)
 
-Click *BlueprintToRSTDoc* button or execute *Window* > *BlueprintToRSTDoc*.  
-Then, specify the output directory of generated documents. (This process will
-be skipped when the setting *Path > Always Ask Output Directory* is off.)
+1. Click *BlueprintToRSTDoc* button or execute *Tools* > *Generate RST Document*.
+2. Specify the output directory of generated documents from the opened window.
+   (This process will be skipped when the setting *Path* >
+   *Always Ask Output Directory* is off.)
+3. Message box will be popped up after documents generated.
 
-After generating documents, message box will be popped up.  
-Generated documents are located on the directory you specified.
+Generated documents are located on the specified directory.
 
 ## 3. Use Sphinx to generate pretty documents (Optional)