Back to Onetbb

How to build oneTBB documentation

doc/README.md

2023.0.0645 B
Original Source

How to build oneTBB documentation

Our documentation is written in restructured text markup (.rst) and built using Sphinx.

This document explains how to build oneTBB documentation locally.

Prerequisites

  • Python 3.7.0 or higher
  • Sphinx

Build documentation

Do the following to generate HTML output of the documentation:

  1. Clone oneTBB repository:
git clone https://github.com/uxlfoundation/oneTBB.git
  1. Go to the doc folder:
cd oneTBB/doc
  1. Run in the command line:
make html

That's it! Your built documentation is located in the build/html folder.