You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is the long-term plan to stick with GH-pages, or move to something else? For the current GH pages, the docs dir will need to be re-organized keeping each version in a subdirectory.
Hack the existing theme to add a simple, json-based multi-ver support (which I showed can be done, see, e.g. nvmath-python et al). I believe the same approach can be applied to furo too, given that it already has the infra following RTD.
Is the long-term plan to stick with GH-pages, or move to something else?
I think using the GH pages is OK. The internal workflow can be slightly more demanding.
For the current GH pages, the docs dir will need to be re-organized keeping each version in a subdirectory.
That is fine with me. I'd also like to use this opportunity to purge the doc artifacts from the main/release branches, following the common practice. In short:
The main/release branches should only contain the doc sources (= source code + Sphinx rst files)
The gh-pages branch that we use to publish the docs should only contain the doc artifacts (=html files)
If we switch to a multi version doc, all versions will be kept under a subdirectory as you suggested
2. Hack the existing theme to add a simple, json-based multi-ver support (which I showed can be done, see, e.g. nvmath-python et al). I believe the same approach can be applied to furo too, given that it already has the infra following RTD.
I confirm in #165 that this works, so we can defer the theme change to a later stage and not mixing it together with other decisions to make.
Activity
bryevdv commentedon Sep 11, 2024
Using PSD theme (or any derived themes e.g. the NV theme) this is nominally a matter of adding a
switcher.jsonand updating it on new releases:https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/version-dropdown.html
Is the long-term plan to stick with GH-pages, or move to something else? For the current GH pages, the
docsdir will need to be re-organized keeping each version in a subdirectory.leofang commentedon Sep 16, 2024
Thanks for checking, @bryevdv!
It seems we currently use the
furotheme (first time hearing this theme...)cuda-python/docs_src/source/conf.py
Lines 57 to 58 in e1e3325
@vzhurba01 do you recall why we used
furoinstead of the PyData one?Note that
furostill does not have multi-ver doc support (pradyunsg/furo#372; WIP in pradyunsg/furo#500), so we have 2 choices:furotoo, given that it already has the infra following RTD.I think using the GH pages is OK. The internal workflow can be slightly more demanding.
That is fine with me. I'd also like to use this opportunity to purge the doc artifacts from the
main/release branches, following the common practice. In short:main/release branches should only contain the doc sources (= source code + Sphinx rst files)gh-pagesbranch that we use to publish the docs should only contain the doc artifacts (=html files)leofang commentedon Sep 16, 2024
Another perhaps silly question: Does the GH page support the JS + Json based version selector?
vzhurba01 commentedon Sep 16, 2024
I don't recall. Looking back I see that @mmccarty was the one who helped up setup the docs initially.
leofang commentedon Oct 10, 2024
Bumping this to P0 as this could have been a gatekeeper for issues like #140.
leofang commentedon Oct 14, 2024
I confirm in #165 that this works, so we can defer the theme change to a later stage and not mixing it together with other decisions to make.
Merge pull request NVIDIA#95 from robertmaynard/cuda-13-soname-updates