oneDNN icon indicating copy to clipboard operation
oneDNN copied to clipboard

How to switch different doc version?

Open alanzhai219 opened this issue 10 months ago • 6 comments

https://oneapi-src.github.io/oneDNN/ is always the latest docs. If I want to read the old one, how to switch it?

alanzhai219 avatar Mar 10 '25 06:03 alanzhai219

@alanzhai219, docs for previous versions are available in vX.Y folders. For example, oneDNN v3.0 documentation is published at https://oneapi-src.github.io/oneDNN/v3.0.

We are not publishing documentations for versions prior to v3.0, so the only option there is building from source.

vpirogov avatar Mar 10 '25 14:03 vpirogov

@vpirogov Thanks. vX.Y works. It looks like an implicit website for customers. Would you be willing to add an explicit switch button? It should be very user-friendly.

alanzhai219 avatar Mar 12 '25 02:03 alanzhai219

@alanzhai219, this was my dream for a while. Just need someone who can make this happen in Sphinx.

vpirogov avatar Mar 12 '25 17:03 vpirogov

@vpirogov That's great. Listen to and evaluate developers' suggestions. Polish your projects.

alanzhai219 avatar Mar 13 '25 02:03 alanzhai219

Hi, I would like to help in implementing this button to switch documentation versions, if that's posible

alektebel avatar Mar 25 '25 09:03 alektebel

@alektebel, this would be great.

Complete source code for oneDNN documentation is sitting in /doc directory. Build instructions are included in the developer guide.

vpirogov avatar Mar 25 '25 15:03 vpirogov