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

Standardize documentation for ReadtheDocs #73

Merged
merged 1 commit into from
Jan 2, 2024
Merged

Conversation

samjwu
Copy link
Member

@samjwu samjwu commented Dec 29, 2023

Apply the following changes to project documentation for ReadtheDocs:

add version number to documentation left navigation bar and page title
add an "About" section with a license page
enable htmlzip, pdf, epub formats when publishing on Read the Docs
set pdf title, author, copyright, and version
rename .sphinx/.doxygen to sphinx/doxygen
remove docBin from URL
update rocm-docs-core dependency
update dependabot config

Relates to ROCm/rocm-docs-core#330

@samjwu samjwu added documentation Improvements or additions to documentation ci:docs-only Skip most non doc CI for this PR labels Dec 29, 2023
@samjwu samjwu self-assigned this Dec 29, 2023
Copy link
Collaborator

@vin-huang vin-huang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@samjwu samjwu merged commit 23d9be8 into ROCm:develop Jan 2, 2024
3 checks passed
@samjwu samjwu deleted the rtd branch January 2, 2024 17:37
yhuiYH pushed a commit that referenced this pull request Apr 16, 2024
yhuiYH added a commit that referenced this pull request Apr 16, 2024
* Standardize documentation for ReadtheDocs (#73)

* update ROCm naming (#60)

* updated index, toc, and Related Info (#67)

* updated index, toc, and Related Info

* Update .wordlist.txt

Added:
NONINFRINGEMENT
sublicense

* Restored LICENSE.md and removed Related Information

* Update license.md

added new line

* Correct broken links (#76)

* Update LICENSE.md

update to 2024

* Update index.rst

change links from .md to .html

* Update index.rst

on the Licensing page

* Card alignment (#81)

* link fixes, cleanup

---------

Co-authored-by: Sam Wu <sam.wu2@amd.com>
Co-authored-by: Lisa <lisa.delaney@amd.com>
Co-authored-by: randyh62 <42045079+randyh62@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs-only Skip most non doc CI for this PR documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants