Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Bump Sphinx and Pydata versions #24083

Merged
merged 37 commits into from
Apr 18, 2024
Merged
Show file tree
Hide file tree
Changes from 30 commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
0b1901c
new bulild changes
bbielawx Mar 21, 2024
66be213
remove thirdparty/ade
bbielawx Mar 21, 2024
dab054d
fix req.txt
bbielawx Mar 21, 2024
3785ed4
further fix req.txt
bbielawx Mar 21, 2024
e5dc5e2
further fix req.txt
bbielawx Mar 21, 2024
e1a69ab
further fix req.txt
bbielawx Mar 21, 2024
5041670
further fix req.txt
bbielawx Mar 22, 2024
ddffbae
further fix req.txt
bbielawx Mar 22, 2024
87a409a
further fix req.txt
bbielawx Mar 22, 2024
e3258f6
fix path for the new mapping file
bbielawx Mar 22, 2024
9b54fe0
further fix req.txt
bbielawx Mar 22, 2024
75519e9
fix light mode for pydata
bbielawx Mar 22, 2024
39fb6ed
edit cmake add path to articles_en, fix test error
bbielawx Mar 22, 2024
241411f
fix and merge code before relase
bbielawx Mar 25, 2024
bcb825d
fix theme options
bbielawx Mar 25, 2024
4a74c2e
fix theme color
bbielawx Mar 25, 2024
cfe0ad6
fix theme and requirements.txt
bbielawx Mar 25, 2024
a5743d1
fix light theme options
bbielawx Mar 25, 2024
95ab826
fix sd-tabs
bbielawx Apr 8, 2024
6c20ae2
comment footer for jenkins build
bbielawx Apr 8, 2024
bc93b61
add myst configuration to the conf.py
bbielawx Apr 11, 2024
e3a682c
uncomment footer_items
bbielawx Apr 15, 2024
3ba8f3a
revert cmakelists.txt and update homepage changes into index.rst
bbielawx Apr 15, 2024
3a88783
footer_info comment
bbielawx Apr 15, 2024
e4b5b4a
reduce myst_heading_anchors
bbielawx Apr 16, 2024
29f39ee
modify myst configuration
bbielawx Apr 16, 2024
36d9613
footer changes
bbielawx Apr 16, 2024
19a0111
myst fixes, ovms mapping function, add homepage_style update
bbielawx Apr 16, 2024
a1ff8ba
Merge remote-tracking branch 'upstream/master' into new-build-v2
bbielawx Apr 17, 2024
9d84455
remove home.rst file from docs
bbielawx Apr 17, 2024
aaa45a5
add openvino to requirements.txt and remove sphinx.log
bbielawx Apr 17, 2024
b2dce76
Merge branch 'master' into new-build-v2
akopytko Apr 17, 2024
564d08f
remove sphinx.log and version.txt
bbielawx Apr 17, 2024
01d3e4e
remove OV_models_supported pdfs
bbielawx Apr 17, 2024
1db4446
PR request changes
bbielawx Apr 17, 2024
2fa3984
Merge branch 'master' into new-build-v2
kblaszczak-intel Apr 17, 2024
78ab479
Merge branch 'master' into new-build-v2
akopytko Apr 17, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ temp/
CMakeLists.txt.user
docs/IE_PLUGIN_DG/html/
CMakeUserPresets.json
venv

*.project
*.cproject
Expand Down Expand Up @@ -73,4 +74,4 @@ coverage
/src/plugins/intel_cpu/tools/commit_slider/*.json
/src/plugins/intel_cpu/tools/commit_slider/slider_cache/*
/src/plugins/intel_cpu/thirdparty/ComputeLibrary/build/*
.github/GITHUB_OUTPUT
.github/GITHUB_OUTPUT
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -165,4 +165,4 @@ endif()
# provides a callback function to describe each component in repo
include(cmake/packaging/packaging.cmake)

ov_cpack(${OV_CPACK_COMPONENTS_ALL})
ov_cpack(${OV_CPACK_COMPONENTS_ALL})
2 changes: 2 additions & 0 deletions docs/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ function(build_docs)
set(ARTICLES_HELPER_SCRIPT "${SCRIPTS_DIR}/articles_helper.py")
set(COPY_IMAGES_SCRIPT "${SCRIPTS_DIR}/copy_images.py")
set(DOXYGEN_MAPPING_SCRIPT "${SCRIPTS_DIR}/create_mapping.py")
set(DOCS_MAPPING_SCRIPT "${SCRIPTS_DIR}/create_doc_mapping.py")
set(BREATHE_APIDOC_SCRIPT "${SCRIPTS_DIR}/apidoc.py")

# Doxygen/Sphinx setup
Expand Down Expand Up @@ -107,6 +108,7 @@ function(build_docs)
POST_BUILD
COMMAND ${Python3_EXECUTABLE} ${COPY_IMAGES_SCRIPT} ${DOXYGEN_XML_OUTPUT} ${SPHINX_SOURCE_DIR}
COMMAND ${Python3_EXECUTABLE} ${DOXYGEN_MAPPING_SCRIPT} ${DOXYGEN_XML_OUTPUT} ${DOCS_BUILD_DIR} ${OpenVINO_SOURCE_DIR}/../
COMMAND ${Python3_EXECUTABLE} ${DOCS_MAPPING_SCRIPT} ${DOCS_BUILD_DIR} ${ARTICLES_EN_DIR}
COMMAND ${CMAKE_COMMAND} -E copy_directory ${SPHINX_SETUP_DIR} ${SPHINX_SOURCE_DIR}
${post_commands}
VERBATIM)
Expand Down
186 changes: 0 additions & 186 deletions docs/home.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/index.html

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import xml.etree.ElementTree as ET
from sphinx_sitemap import setup as base_setup, get_locales, hreflang_formatter
import queue
from pathlib import Path
from sphinx_sitemap import setup as base_setup, get_locales, hreflang_formatter, add_html_link, record_builder_type
from sphinx.util.logging import getLogger

logger = getLogger(__name__)

def setup(app):
app.add_config_value(
Expand All @@ -19,7 +23,9 @@ def setup(app):
for listener in app.events.listeners['build-finished']:
if listener.handler.__name__ == 'create_sitemap':
app.disconnect(listener.id)


app.connect("builder-inited", record_builder_type)
app.connect("html-page-context", add_html_link)
app.connect('build-finished', create_sitemap)
return setup

Expand All @@ -30,11 +36,15 @@ def create_sitemap(app, exception):
urlset = app.builder.config.ov_sitemap_urlset
meta = app.builder.config.ov_sitemap_meta

site_url = app.builder.config.site_url
site_url = site_url.rstrip('/') + '/'
if not site_url:
print("sphinx-sitemap error: no site_url"
"are set in conf.py. Sitemap not built.")
site_url = app.builder.config.site_url or app.builder.config.html_baseurl
if site_url:
site_url.rstrip("/") + "/"
else:
logger.warning(
"sphinx-sitemap: html_baseurl is required in conf.py." "Sitemap not built.",
type="sitemap",
subtype="configuration",
)
return
if (not app.sitemap_links):
print("sphinx-sitemap warning: No pages generated for %s" %
Expand All @@ -51,7 +61,7 @@ def create_sitemap(app, exception):
for item in urlset:
root.set(*item)

get_locales(app, exception)
locales = get_locales(app, exception)

if app.builder.config.version:
version = app.builder.config.version + '/'
Expand All @@ -78,7 +88,7 @@ def create_sitemap(app, exception):
ET.SubElement(namespace_element, tag_name).text = tag_value

if len(app.locales) > 0:
for lang in app.locales:
for lang in locales:
lang = lang + '/'
linktag = ET.SubElement(
url,
Expand All @@ -90,10 +100,10 @@ def create_sitemap(app, exception):
lang=lang, version=version, link=link
))

filename = app.outdir + "/" + app.config.sitemap_filename
filename = Path(app.outdir) / app.config.sitemap_filename
ET.ElementTree(root).write(filename,
xml_declaration=True,
encoding='utf-8',
method="xml")
print("%s was generated for URL %s in %s" % (app.config.sitemap_filename,
site_url, filename))
site_url, filename))
Loading
Loading