198adbf266
* Add profiler to document build scripts * Add script name * Use system doxygen and try to understand the build of each cmake target * Revert doxygen * Try to speed up documentation build * Try to cache results * Added cache for sphinx * Remove profilers * Fix install dependencies * Restored config options * Added ccache * Cache python and update sphinx * Update packaging * Revert sphinx upgrade * Don't need to clone recursive * Revert "Don't need to clone recursive" This reverts commit7a2043df7b. * Change cache apt action * Updated ccache calls * Don't use recursice init * Update sphinx to 4.5 * Fixed indent * Disable all custom code in theme * Remove quite mode * Revert "Disable all custom code in theme" This reverts commit096ca2f329. * Removed dependency on python * Disable code analyse * Disable common functions * Revert edit page * Minimize the number of cycles for li * Fixed is none * Try to fix build * Disable sidebar * Revert "Disable sidebar" This reverts commit64303ee94f. * Return raw html * Removed private information * Avoid generation multiple artifacts * Added additional step to collect ccache * Small change * Fixed typo * Added comments
openvino_sphinx_theme
Installation and usage
- Install the
openvino_sphinx_themeusingpython:
python setup.py install --user
- Update the
html_themevariable in yourconf.py:
html_theme = 'openvino_sphinx_theme'
Configuration
Theme Logo
To add a logo at the left of your navigation bar, use html_logo variable to set the path to the logo file.
html_logo = <path to the logo file>
Version and language selectors
To enable a version and language selectors, add the following configuration to your conf.py in html_context:
html_context = {
'current_version': 'latest',
'current_language': 'en',
'languages': (('English', '/en/latest/'), ('Chinese', '/cn/latest/')),
'versions': (('latest', '/en/latest/'), ('2022.1', '/en/2022.1'))
}
You can add selectors only for versions or languages.
If you want to add version selector you must define both current_version and versions properties.
If you want to add version selector you must define both current_language and languages properties.
Maintainers
- OpenVINO Documentation team