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

doc: updates to open source site #2858

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ranukund
Copy link
Contributor

Description

As notified via email, this PR contains the following:

Including the oneAPI symbol on the site to showcase the oneDNN library is a part of the oneAPI ecosystem.
Formatting the oneDNN documentation text and version number
Ability to create issues directly from the documentation pages.
Including an option to download documentation as a PDF/RST format

Here's a preview site: https://scaling-adventure-y65ggqw.pages.github.io/

@ranukund ranukund requested review from a team as code owners March 11, 2025 18:51
@github-actions github-actions bot added documentation A request to change/fix/improve the documentation. Codeowner: @oneapi-src/onednn-doc component:build labels Mar 11, 2025
@vpirogov
Copy link
Contributor

Here's a preview site: https://scaling-adventure-y65ggqw.pages.github.io/

It looks like your preview site uses different versions of Sphinx or Sphinx Book Theme in comparison to what is used on Github pages. You can find exact versions of tools used in doc/environment.yml. The changes will not look as you expect unless the versions match.

Build with current versions does not make any difference for log:

WARNING: unsupported theme option 'logo' given

image

@vpirogov
Copy link
Contributor

A subset of these changes works nice and can be promoted, including:

  • Adding oneAPI logo and favicon
  • Enabling issue reporting
  • Enabling download button for pdfs
  • Wording, copyright and branch name changes

@ranukund
Copy link
Contributor Author

A subset of these changes works nice and can be promoted, including:

  • Adding oneAPI logo and favicon
  • Enabling issue reporting
  • Enabling download button for pdfs
  • Wording, copyright and branch name changes

Sounds great!

@ranukund ranukund force-pushed the ranuk/open-source-doc-updates branch from a695ea4 to a9c1fd0 Compare March 12, 2025 17:25
@ranukund ranukund force-pushed the ranuk/open-source-doc-updates branch from a9c1fd0 to c4dcda2 Compare March 13, 2025 17:14
@ranukund ranukund requested review from a team as code owners March 13, 2025 17:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation A request to change/fix/improve the documentation. Codeowner: @oneapi-src/onednn-doc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants