diff options
| author | Matheus Richard <matheusrichardt@gmail.com> | 2023-10-19 20:45:07 -0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-10-20 08:45:07 +0900 |
| commit | 72f97ee06ebca8d33ca419c7b413568fca6c3b7e (patch) | |
| tree | 2a2591ccf9c75029de89a20d6a3e37c958940703 | |
| parent | bd2aee67c172b033f8b18fc2182b5f4d2ef50bec (diff) | |
| download | ruby-72f97ee06ebca8d33ca419c7b413568fca6c3b7e.tar.gz | |
[DOC] Improve docs for how to generate documentation
It might not be obvious how to get the build directory and the Makefile
set up.
| -rw-r--r-- | doc/contributing/documentation_guide.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/contributing/documentation_guide.md b/doc/contributing/documentation_guide.md index 25a5fa1673..af91817003 100644 --- a/doc/contributing/documentation_guide.md +++ b/doc/contributing/documentation_guide.md @@ -20,10 +20,12 @@ build directory: make html ``` +If you don't have a build directory, follow the [quick start +guide](building_ruby.md#label-Quick+start+guide) up to step 4. + Then you can preview your changes by opening `{build folder}/.ext/html/index.html` file in your browser. - ## Goal The goal of Ruby documentation is to impart the most important |