From e386960a777c43c2111f8411259c33fdb7bfea18 Mon Sep 17 00:00:00 2001
From: Alexandra <alexandra.epanchinzeva@intel.com>
Date: Fri, 4 Mar 2022 19:49:25 +0300
Subject: [PATCH] Instruction for building the docs locally  (#778)

---
 doc/Makefile  | 36 ++++++++++++++++++++++++++++++++++
 doc/README.md | 34 +++++++++++++++++++++++++++++++++
 doc/make.bat  | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 123 insertions(+)
 create mode 100644 doc/Makefile
 create mode 100644 doc/README.md
 create mode 100644 doc/make.bat

diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 0000000000..3ac68fcfb6
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,36 @@
+#===============================================================================
+# Copyright (C) 2022 Intel Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#===============================================================================
+
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = doc
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 0000000000..0cdd56f9c1
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1,34 @@
+# How to build oneTBB documentation
+
+Our documentation is written in restructured text markup (.rst) and built using [Sphinx](http://www.sphinx-doc.org/en/master/). 
+
+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/oneapi-src/oneTBB.git
+```
+
+2. Go to the `doc` folder:
+
+```
+cd oneTBB/doc
+```
+
+3. Run in the command line:
+
+```
+make html
+```
+
+
+That's it! Your built documentation is located in the ``build/html`` folder. 
diff --git a/doc/make.bat b/doc/make.bat
new file mode 100644
index 0000000000..557ecc5b62
--- /dev/null
+++ b/doc/make.bat
@@ -0,0 +1,53 @@
+@ECHO OFF
+
+rem ============================================================================
+rem Copyright (C) 2022 Intel Corporation
+rem
+rem Licensed under the Apache License, Version 2.0 (the "License");
+rem you may not use this file except in compliance with the License.
+rem You may obtain a copy of the License at
+rem
+rem     http://www.apache.org/licenses/LICENSE-2.0
+rem
+rem Unless required by applicable law or agreed to in writing, software
+rem distributed under the License is distributed on an "AS IS" BASIS,
+rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+rem See the License for the specific language governing permissions and
+rem limitations under the License.
+rem ============================================================================
+
+
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=doc
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd