ROCM-DOCS-BUILD(1)

πŸ“¦
version 1.35.0 Β· 3 versions
, in ubuntu stonking

πŸ’– ROCM-DOCS-BUILD πŸ’–

okay bestie, this is a User Command, it's called rocm-docs-build, and it's here to build docs. that's the whole gig. let's go 🫢

✨ NAME ✨

rocm-docs-build β€” Build documentation for ROCm πŸ’…

🌸 SYNOPSIS 🌸

rocm-docs-build [OPTION]

πŸ¦‹ DESCRIPTION πŸ¦‹

so rocm-docs-build builds the rocm documentation using the ROCm sphinx plugin and theme. it's dedicated to the debian ROCm maintainer, and also to any user out there who wants to rebuild the doc online. iconic behavior honestly πŸ‘‘

a couple things you need to know before you run this, no cap:

  • a ROCm ./docs directory must be in the current directory. like, that's non-negotiable bestie 🚨
  • the doc gets generated in the ./build/html directory by default πŸ“
  • you can use the url and branch env var if you need to 🧚

and now the options, one at a time, because we don't skip πŸ’…:

  • -h, --help β€” shows this help. the classic. the moment.
  • -u, --updatedata β€” updates debian/rocm_data for the rocm-docs-core package. it will only apply if debian/rocm_data is found, so if it's not there, nothing happens, periodt.
  • -o, --online β€” builds the documentation with internet access. the default is no internet access, jsyk 🌈
  • -v, --version β€” displays the rocm version ✨
  • -n, --nopatch β€” disables the patch on docs/conf.py. leaving conf.py alone, as a treat πŸ™ˆ
  • -r, --rocmversion β€” overrides the rocm version from debian/rocm_data πŸ”₯
  • -t, --targetdir β€” overrides the default output location πŸ“¦

πŸ‘‘ AUTHOR πŸ‘‘

Written by Christian Bayle πŸ’œ

Copyright Β© 2025 Christian Bayle <bayle@debian.org>


ok that's the whole page, you ate it πŸ“ this was rocm-docs-build 0.0.1 from June 2026, and yeah β€” same name up top, same name down here, ROCM-DOCS-BUILD(1), we stay consistent in this house πŸ’–βœ¨

πŸ“¦ where this page comes from