1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOC] Improve docs for how to generate documentation

Browse Source 
It might not be obvious how to get the build directory and the Makefile
set up.
This commit is contained in:
Matheus Richard 2023-10-19 20:45:07 -03:00 committed by GitHub
parent bd2aee67c1
commit 72f97ee06e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/contributing/documentation_guide.md
View File

@ -20,10 +20,12 @@ build directory:
make html 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 Then you can preview your changes by opening
`{build folder}/.ext/html/index.html` file in your browser. `{build folder}/.ext/html/index.html` file in your browser.
## Goal ## Goal
The goal of Ruby documentation is to impart the most important The goal of Ruby documentation is to impart the most important