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

Update Documentation theme from sphinx_rtd_theme to sphinx_book_theme #1046

Merged

Conversation

oliverholworthy
Copy link
Member

Update Documentation theme from sphinx_rtd_theme to sphinx_book_theme

@oliverholworthy oliverholworthy added the documentation Improvements or additions to documentation label Jul 4, 2023
@oliverholworthy oliverholworthy added this to the Merlin 23.07 milestone Jul 4, 2023
@oliverholworthy oliverholworthy self-assigned this Jul 4, 2023
@github-actions
Copy link

github-actions bot commented Jul 4, 2023

Documentation preview

https://nvidia-merlin.github.io/Merlin/review/pr-1046

@mikemckiernan
Copy link
Member

Hi folks, just passing by while trying to view another issue...if you are tempted to change the appearance of the docs, consider using repo_docs:

http://omniverse-docs.s3-website-us-east-1.amazonaws.com/repo_docs/0.37.0/index.html

It's about as close to a "standard" as we have. (As of now, it does not, however, offer a three-column layout like the books theme.)

@oliverholworthy
Copy link
Member Author

Hi folks, just passing by while trying to view another issue...if you are tempted to change the appearance of the docs, consider using repo_docs:

http://omniverse-docs.s3-website-us-east-1.amazonaws.com/repo_docs/0.37.0/index.html

It's about as close to a "standard" as we have. (As of now, it does not, however, offer a three-column layout like the books theme.)

Thanks @mikemckiernan . I copied some of the CSS from the Omniverse docs to get closer to that theme in style. We can do some follow-up work to investigate repo_docs. This PR at least get's us a step closer in appearance (similar to the Triton Docs and NeMo docs)

@oliverholworthy oliverholworthy merged commit b77fd03 into NVIDIA-Merlin:main Jul 5, 2023
@oliverholworthy oliverholworthy deleted the docs-sphinx-book-theme branch July 5, 2023 19:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants