From 72f97ee06ebca8d33ca419c7b413568fca6c3b7e Mon Sep 17 00:00:00 2001 From: Matheus Richard Date: Thu, 19 Oct 2023 20:45:07 -0300 Subject: [PATCH] [DOC] Improve docs for how to generate documentation It might not be obvious how to get the build directory and the Makefile set up. --- doc/contributing/documentation_guide.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) 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