- theme.py: Update path to favicon
- projects.yaml: Remove non-doc cross refs
- custom.css: Use light blue text for banner hyperlinks
- theme.py: Fix phrasing of banner for old doc versions
- projects.py: Update pattern matching for old release announcement
- crop image from left side
- make cards brighter
- adjust padding back to 1
- change card font to san-serif and adjust padding
- change bg image to default one from ROCm/ROCm
- Add css classes for card banners
- projects.yaml: Update doc dev branch for HIP to docs/develop
- projects.yaml: Update development branches for projects
- Doxyfile: Remove unused tags from Doxyfile
- doxygen.py: Fix warning for progress_message
- project.yaml: rocDecode and rocAL default to develop branch now
- Remove unused import
- Remove unused test code
- Remove SphinxTestApp
- Removed deprecated code
- test_projects.py: Format with black
- Update conf.py for site tests
- test_doxygen.py: Fix typo in doxygen dir
- projects: Add intersphinx links to github and files
- Set github version
- Update rocPyDecode link
- projects.yaml: Add llvm-project and rocpydecode
- projects.yaml: Add omniperf and omnitrace
- header.jinja: Make GitHub repo url for install docs point to install docs instead of ROCm home
- core.py: Apply ruff suggested fix
- core.py: Apply ruff suggested fix
- Add google site verification content to theme context
- Add template for google site verification content
- Get versions from data branch instead of header-versions branch
- projects.yaml: Add rocprofiler-sdk to projects
- projects.yaml: add rocminfo and rocm_bandwidth_test to projects list
- custom.css: Change line color at dark mode of multiline list
- projects.yaml: Add rocr_debug_agent to projects.yaml
- Get header version from URL instead of theme.conf
- projects.py: Use ROCm org when checking versions for banner
- theme.py: Point to ROCm org instead of RadeonOpenCompute for rocm-docs-core
- projects.yaml: add rocr-runtime
- custom.css: add bottom margin to images in rst files
- 404.html: Remove relative link in 404.html page
- core.py: Update Sphinx API call to doc2path
- core.py: Format core.py with black
- Address mypy type warnings
- theme.conf: Update header latest version
- footer.html: Bump year to 2024 in footer
- Correct major version for breaking change
- This requires updating
.readthedocs.yaml
(tools.python
) and re-generatingrequirements.txt
for all dependent projects.
- theme.py: Update banner announcement about docs.amd.com redirect
- layout.html: Update google-site-verification metadata
- header.jinja: Update link to infinity hub
- Update rocm flavor header.jinja to Blogs
- header.jinja: Replace Lab Notes link with Blogs
- Fix mypy and isort errors
- Apply black formatting
- fixes for isort
- fixes for isort
- fixes for isort
- mypy fixes
- isort fixes
- Ruff fixes
- Fixes for ruff
- projects.py: Ignore mypy limitation for dynamic type checking
- theme.py: Modify new banner announcement message for latest
- Use type instead of instanceof
- Fix type hints and assertions to pass Python linting
- extra_stylesheet.css: Fix flexbox positioning for doxygen content
- Specify left instead of flex-end
- theme.conf: Update latest version for header
- theme.conf: Create point fix for 6.0.2
- theme.py: Remove banner on latest release
- theme.conf: Update latest header version
- footer.jinja: Fix license link for rocm flavor
- header.jinja: Update link to infinity hub
- theme.py: Update banner announcement about docs.amd.com redirect
- Update rocm flavor header.jinja to Blogs
- header.jinja: Replace Lab Notes link with Blogs
- theme.py: Modify new banner announcement message for latest
- left-side-menu.jinja: Fix main doc link for rocm flavor left side menu
- Update left side menu
- core.py: Add html_image myst extension
- core.py: Enable dollarmath myst extension for inline latex math
- left-side-menu.jinja: Set main doc link for blogs flavor
- remove old folder
- Revert "fix: remove toc"
- remove toc
- remove duplicates
- merge conflicts
- header.html: Import version_list macro from header.jinja into header.html
- Change rocm-blogs flavor top level header to ROCm Blogs
- Change rocm-blogs second level header Lab Notes to ROCm Docs
- Remove version list from rocm-blogs header
- theme.py: Add rocm-blogs to lsit of supported flavors
- Add ROCm blogs flavor
- header.jinja: New statement block for setting custom repo url
- rocm-blogs/footer.jinja: Refactor to pass Python linting
- theme.conf: Update header latest version
- theme.conf: Update header latest version
- Read versions for theme header from link instead of setting in theme.conf
- projects.py: Read header versions from link instead of hard-coding
- Remove carriage return and newline when checking versions
- sync wordlist
- header.jinja: Fix support link in header for rocm-docs-core
- theme.conf: Add back header options to theme.conf to pass RTD PR build
- Use requests instead of urllib3
- theme.py: Set html_context in default_config_opts rather than theme_opts
- dependabot.yml: Change dependabot config
- adding linux and windows site fixes
- flavors: Fix the rocm-docs-home flavor
- Don't add a subproject link as its own project in projects.yaml
- Rename rocm-api-tools-list theme to rocm-docs-home
- Updating our links for installation subprojects
- theme.py: Add list flavor to list of supported flavors
- Rename list theme to rocm-api-tools-list
- projects.yaml: Add linux install guide to projects.yaml
- Add new flavor - list theme
- Add all versions link to header
- Header name change to AMD ROCm Software
- projects.yaml: Add rocDecode to projects
- doxygen.py: Enable doxygen extended toc with forked doxysphinx
- projects.yaml: Add hip-vs
- doxygen.py: automatic setup of doxylink
- Update latest ROCm version in projects.py and theme.conf
- doxygen,projects: Make doxygen tagfile available
- projects.py: Allow to fetch project indices explicitly
- projects: always resolve project references in TOC and templates
- util.py: Modify RTD regex to allow for .org sites
- theme.py: Partially handle not being in a git repository
- doxygen.py: Pass doxygen executable to doxysphinx
- tests: Move project tests to separate file
- Set latest version to 5.7.1
- projects.yaml: add radeon
- util.py: Copy files relative to the source directory
- doxygen.py: Only continue if existing file is directory
- theme.py: Simplify 404 document handling
- header.jinja: only modify theme_repository_url if it ends with -docs
- theme.conf: update header version
- copy common 404.md source file to projects
- theme.py: copy theme util pages on builder init
- projects.yaml: add hipsparselt to projects yaml
- projects.yaml: add hiptensor to projects.yaml
- projects.yaml: Add ROCmCMakeBuildTools to projects.yaml
- update latest version to 5.6.1
- projects.yaml: add dev branch for rvs and rocal
- Add config option to specify doxygen exe
- Add reusable md rst linting
- Turn linting workflow into reusable
- core.py: fix setting up the base url for the 404 page
- one-off indentation
- config handling style
- MD032
- MD031
- add missing mdlint config file
- Add "local" flavor for providing the flavor in the project
- Add support for theme "flavors"
- projects.py,theme.py: Decouple announcement strings from projects.py
- projects.py: Don't read projects.yaml again for release announcement
- projects.py: replace uses of _load_mapping with _create_mapping
- projects.py: Make Project creation more explicit
- projects.yaml: add rpp to projects.yaml
- projects.yaml: add more projects to yaml
- projects.py: use development_branch string instead of variable
- update latest version to 5.6.0
- projects.py: do not have an announcement stating the latest version
- header.html: revert flyout to default position for consistency
- add extrahead block with metadata in layout.html
- update announcement for RC of ROCm
- map rocm version in projects.yaml to header.html version number
- use theme.conf for header version numbers
- place rocm latest version in projects.yaml
- hardcode the url for ROCm docs
- util.py: formatting fix for ruff; return result of regex on remote_url
- projects.py: use formatted string for doc latest url
- add announcement for unreleased and old branches
- header.html: remove "docs-" from theme repo branch in header
- update banner
- formatting fixes for ruff linting
- header.html: test rtd embed flyout div
- theme.py: remove unnecessary open mode param UP015 for ruff
- remove trailing whitespaces
- refactor theme announcement logic
- move banner logic to projects.py
- include latest version url in announcement if not on latest
- Updating announcement banner
- projects: expose project urls to html templates
- projects.yaml: remove hardcoding of rocm to develop
- header.html: write to header in italics if future release or release candidate
- header.html: include the version number in the top level header if the branch contains it
- rdcMisc.js: toggle light/dark mode caption when changing themes
- header.html: make the added part in italics for top level header
- _toc.yml.in: correct toc typo
- move theme mode captions to separate js file
- rdcMisc.js: use 4 spaces for tabs in rdcMisc
- init.py: stop searching CMakeLists.txt for version string
- New email address
- custom.css: force navbar text to left align
- Fix footer interaction with flyout nav
- CSS fixes around announcement banner
- doxygen.py: remove extra print statement when copying over doxygen styling files
- left-side-menu: rename main doc link to ROCm Documentation Home
- left-side-menu.html: dynamically change homepage link for develop branch
- add link to ROCm docs home to top of TOC
- header.html: fix link to amd.com
- include master branch for left side menu
- update development_branches
- include dev branch names in left-side-menu
- move yaml file to data folder
- add yaml with development branches
- dynamically change branch in left side menu
- Add announcement banner.
- announcement URL and phrasing
- header.html: point docs repos to library repos
- core.py: use round to nearest minute for read time
- versioning script mismatch
- Nav bar links to project GitHub
- projects: allow overriding toc template path
- projects: mapping between project versions
- projects: allow overriding and disabling external mappings from conf.py
- intersphinx: Support intersphinx base urls in toc.yml
- intersphinx: support single strings for project
- intersphinx: add version replacement in the yaml
- intersphinx: Allow overriding branch name via environment variable
- fetch intersphinx config from a remote file
- rocm_footer.css: Fix overlap with sidebar
- renameVersionLinks.js: Wait for RTD injection
- Still get PR branch using pygithub
- Use RTD environment variables
- Remove edit button, simplify get_branch
- init.py: remove deprecated and unused method
- projects: rename external_intersphinx to projects
- doxygen: Copy only doxygen folder from data
- article-info: hotfix non-html builds breaking
- Fix python typing, formatting, PEP8
- sidebar: fix rtd version selector not appearing on the sidebar for small screens
- sidebar: fix page jump when sidebar is opened, animate header
- header: don't show scroll-bar on menu when its not needed
- article-info: Use app.outdir for html directory
- allow overriding path to external toc path
- custom.css: restore cookie settings button styling
- core.py: fix mypy errors
- article-info: Simplify article-info handling
- Fix header on narrow screens
- Remove left side menu & buttons
- Fix lengths on shorter breadcrumbs
- Add zero width spaces when testing width
- Add links to header
- Merge remote-tracking branch 'upstream/develop' into HEAD
- check for existing article info before inserting
- core.py: use older version of pretty format in git log command
- Bring into compliance with AMD styling
- core.py: set default publish date as time article was last modified
- core.py: set default read time by counting visible words in html output
- deprecate disable_main_doc_link
- fix breadcrumbs and scrolling
- update ROCm Documentation url
- Tighten secondary nav
- Improve transitioning on resize
- add back linkify
- merge with develop branch
- get file modification time using git
- import article info via importlib.resources
- Rename versioned doc links with version number
- Remove unintended CSS changes
- convert myst_enable_extensions to set and add configunion helper
- core.py: explicitly cast to list
- docutil dependency
- core.py: set specific page settings first before setting general settings
- core.py: add ability to set article info for all pages
- allow substitutions for author, date, and read time in article info
- add article info for linux and windows
- core.py: add article info with supported os info
- deps: Fix search highlight in doxysphinx by updating sphinx version
- use consistent formatting for init and remove empty list from core
- core.py: move linkcheck configs to core from init
- use different link color based on theme
- increase font size
- header: direct GitHub header link to ROCm
- init.py: add version numbers
- ensure compatibility for 3.8 through 3.11
- dependabot.yml: remove extra spaces
- users of the non-legacy API have to set
html_theme
torocm_docs_theme
to maintain the current behaviour.
- legacy: fix builds without doxygen
- extension: no longer set the html_theme by default in the extension
- legacy: restore custom theme on readthedocs
- move automatic doxygen and doxysphinx to an extension
- move core settings to a sphinx extension
- restore cookie permissions / analytics script
- various formatting and type fixes in util.py
- various stlysheet fixes
- update links in header and footer (#87)