Skip to content

Commit

Permalink
Update: Documents
Browse files Browse the repository at this point in the history
  • Loading branch information
nutti committed Dec 11, 2023
1 parent 297e343 commit aa5ceb5
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -1323,4 +1323,6 @@ void UBlueprintToRSTDocBPLibrary::GenerateRSTDoc(const FString& OutputDirectory,
return;
}
}

bSuccess = true;
}
Binary file added docs/images/tutorial/generate_documents.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/tutorial/plugin_configuration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/tutorial/process_2.png
Binary file not shown.
4 changes: 3 additions & 1 deletion docs/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -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*.

Expand All @@ -25,7 +27,7 @@ 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)

1. Click *BlueprintToRSTDoc* button or execute *Tools* > *Generate RST Document*.
2. Specify the output directory of generated documents from the opened window.
Expand Down

0 comments on commit aa5ceb5

Please sign in to comment.