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 9758655 commit e21664a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-
Expand Down
11 changes: 6 additions & 5 deletions docs/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,13 @@ The configuration for this plugin is available on *Settings* >

![Tutorial Process 2](images/tutorial/process_2.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)

Expand Down

0 comments on commit e21664a

Please sign in to comment.