From 5b85cfe1ca786cf89bb92396c5b7452537a52c0c Mon Sep 17 00:00:00 2001 From: tadamczx <156996781+tadamczx@users.noreply.github.com> Date: Thu, 16 May 2024 11:42:14 +0200 Subject: [PATCH] [DOCS] fix openvino_custon_sphinx_sitemap installation (#24536) ### Details: - *item1* - *...* ### Tickets: - *ticket-id* --- .github/workflows/build_doc.yml | 1 + docs/documentation_build_instructions.md | 9 +++++++-- docs/requirements.txt | 3 +-- 3 files changed, 9 insertions(+), 4 deletions(-) diff --git a/.github/workflows/build_doc.yml b/.github/workflows/build_doc.yml index 3efacaac3d7..665d1afff1f 100644 --- a/.github/workflows/build_doc.yml +++ b/.github/workflows/build_doc.yml @@ -39,6 +39,7 @@ jobs: run: | python3 -m pip install -r docs/requirements.txt (cd docs/openvino_sphinx_theme && python3 setup.py install) + python3 -m pip install docs/openvino_custom_sphinx_sitemap - name: Download and install doxygen run: | diff --git a/docs/documentation_build_instructions.md b/docs/documentation_build_instructions.md index 31759abb9b3..490da1b1029 100644 --- a/docs/documentation_build_instructions.md +++ b/docs/documentation_build_instructions.md @@ -21,17 +21,22 @@ $ apt install -y doxygen graphviz texlive ``` $ python3 -m venv env $ source env/bin/activate +(env) $ pip install --upgrade setuptools pip (env) $ pip install -r docs/requirements.txt ``` 5. Install the sphinx theme ``` (env) $ cd docs/openvino_sphinx_theme && python setup.py install && cd - `````` -6. Create build folder: +6. Install the custom sphinx sitemap +``` +(env) $ pip install docs/openvino_custom_sphinx_sitemap +`````` +7. Create build folder: ``` (env) $ mkdir build && cd build ``` -7. Build documentation using these commands: +8. Build documentation using these commands: ``` (env) $ cmake .. -DENABLE_DOCS=ON (env) $ cmake --build . --target sphinx_docs diff --git a/docs/requirements.txt b/docs/requirements.txt index 8190566c906..d1ab690dcf9 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -46,5 +46,4 @@ sphinxcontrib-qthelp==1.0.3 sphinxcontrib-serializinghtml==1.1.9 toml==0.10.2 urllib3==1.26.18 -zipp==3.4.1 -docs/openvino_custom_sphinx_sitemap \ No newline at end of file +zipp==3.4.1 \ No newline at end of file