Building on macOS¶
Converting the RST-files into pretty HTML pages.
Open a terminal to the folder
~/blender_docs and simply run:
This is the command you will always use when building the docs. The building process may take several minutes the first time (or after any major changes), but the next time you build it should only take a few seconds.
Viewing the Local Manual¶
Once the docs have been built, all the HTML files can be found inside
build/html/index.html in your web browser and read the manual:
Now that you are able to build the manual, the next paragraph is about an optional quick build.
Building a Single Chapter¶
If you are working on a specific chapter of the manual, you can build it quickly using:
make <chapter name>
For example, to build only the documentation for the modifiers, use
You can then view this quick build by opening
This will build very quickly, but it will mean your next complete build of all the chapters will be slow.
Continue with the next step: Editing.