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.

Sign up for GitHub

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

Jump to bottom

Move to new, unified, NVIDIA sphinx theme #5471

Merged
merged 7 commits into from
May 21, 2024
Merged

Move to new, unified, NVIDIA sphinx theme #5471

merged 7 commits into from
May 21, 2024

Conversation

JanuszL
Copy link
Contributor

@JanuszL JanuszL commented May 15, 2024 •
edited
Loading

  • moves to the NVIDIA sphinx based theme
  • adds a new version switcher

Category:

Other (e.g. Documentation, Tests, Configuration)

Description:

  • moves to the NVIDIA sphinx based theme
  • adds a new version switcher

Additional information:

Affected modules and functionalities:

  • docs

Key points relevant for the review:

  • NA

Tests:

  • Existing tests apply
  • New tests added
    • Python tests
    • GTests
    • Benchmark
    • Other
  • N/A

Checklist

Documentation

  • Existing documentation applies
  • Documentation updated
    • Docstring
    • Doxygen
    • RST
    • Jupyter
    • Other
      • sphinx theme
  • N/A

DALI team only

Requirements

  • Implements new requirements
  • Affects existing requirements
  • N/A

REQ IDs: N/A

JIRA TASK: N/A

@JanuszL
Move to new, unified, NVIDIA sphinx theme
ededeb1 
- moves to the NVIDIA sphinx based theme
- adds a new version switcher

Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
github-advanced-security[bot]
github-advanced-security bot found potential problems May 15, 2024
View reviewed changes
docs/conf.py Fixed Show fixed Hide fixed
docs/conf.py Dismissed Show dismissed Hide dismissed
docs/conf.py Dismissed Show dismissed Hide dismissed
docs/conf.py Fixed Show fixed Hide fixed
@JanuszL JanuszL force-pushed the new_theme branch 2 times, most recently from c2b84b2 to efd750d Compare May 15, 2024 18:30
@JanuszL JanuszL marked this pull request as draft May 15, 2024 18:32
@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15040335]: BUILD STARTED

github-advanced-security[bot]
github-advanced-security bot found potential problems May 15, 2024
View reviewed changes
docs/conf.py Fixed Show fixed Hide fixed
docs/conf.py Fixed Show fixed Hide fixed
@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15040335]: BUILD FAILED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15043256]: BUILD STARTED

github-advanced-security[bot]
github-advanced-security bot found potential problems May 15, 2024
View reviewed changes
docs/conf.py Dismissed Show dismissed Hide dismissed
docs/conf.py Outdated
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
try:
import nvidia_sphinx_theme as theme # noqa: F401

Check notice

Code scanning / CodeQL

Unused import Note documentation

Import of 'theme' is not used.
@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15043256]: BUILD FAILED

@JanuszL
Update
bd09649 
Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15055851]: BUILD STARTED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15055864]: BUILD STARTED

github-advanced-security[bot]
github-advanced-security bot found potential problems May 16, 2024
View reviewed changes
docs/conf.py Dismissed Show dismissed Hide dismissed
@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15055864]: BUILD PASSED

@JanuszL JanuszL marked this pull request as ready for review May 16, 2024 13:45
@JanuszL
Copy link
Contributor Author

JanuszL commented May 16, 2024

The version selector doesn't work on out internal docs build due ot:

Access to fetch at 'https://docs.nvidia.com/deeplearning/dali/user-guide/docs/_static/switcher.json' from origin 'http://dali-ci-01:7070' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource. If an opaque response serves your needs, set the request's mode to 'no-cors' to fetch the resource with CORS disabled.```
It should work in the nightly build.

@JanuszL JanuszL marked this pull request as draft May 16, 2024 13:46
@JanuszL JanuszL marked this pull request as ready for review May 16, 2024 13:47
@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15065170]: BUILD FAILED

@JanuszL
Remove tempaltes
14a9e7c 
Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15065287]: BUILD STARTED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15065287]: BUILD PASSED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15075782]: BUILD STARTED

@szkarpinski szkarpinski self-assigned this May 17, 2024
@JanuszL
Fix
84d00f5 
Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15089311]: BUILD STARTED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15089311]: BUILD PASSED

szkarpinski
szkarpinski reviewed May 20, 2024
View reviewed changes
docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
@JanuszL
Review fix
0242a83 
Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
@JanuszL
Review fix
bf0293b 
Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15157882]: BUILD FAILED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15158071]: BUILD STARTED

stiepan
stiepan reviewed May 20, 2024
View reviewed changes
docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15158071]: BUILD PASSED

@JanuszL
More fixes
e50a250 
Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15161216]: BUILD FAILED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15161317]: BUILD STARTED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [15161317]: BUILD PASSED

@JanuszL JanuszL merged commit 708af60 into NVIDIA:main May 21, 2024
6 checks passed
@JanuszL JanuszL deleted the new_theme branch May 21, 2024 16:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@szkarpinski szkarpinski szkarpinski approved these changes

@stiepan stiepan stiepan approved these changes

@jantonguirao jantonguirao jantonguirao approved these changes

Assignees

@stiepan stiepan

@szkarpinski szkarpinski

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@JanuszL @dali-automaton @jantonguirao @stiepan @szkarpinski