RadeonOpenCompute / ROCm_Documentation

Legacy ROCm Software Platform Documentation
http://rocm.docs.amd.com
113 stars 92 forks source link

Update project info in conf.py #133

Closed cgmb closed 3 years ago

cgmb commented 3 years ago

This pull request updates conf.py, which still has a lot of default values left over from the original template. To test these changes, I made my own readthedocs site, which you can temporarily find at https://cgmb-rocm-docs.readthedocs.io.

There's two main things that are fixed by updating this information.

The PDF Cover Page

Compare the current PDF to the PDF for this PR.

The HTML Page Title

The website page title is currently "Welcome to the AMD ROCm™ Platform — ROCm Documentation 1.0.0 documentation"

rocm_page_title

By updating the version, release and project fields in conf.py, this pull request changes it to "Welcome to the AMD ROCm™ Platform — ROCm 4.5.0 documentation"

rocm_page_title_new

The page title isn't always entirely visible, but it does show up fairly regularly in search results (as seen in the image below), so it would be nice to get that corrected. hip_faq_rocm_documentation