x64dbg/docs
Duncan Ogilvie 43892ef41f
Some checks failed
Cross / cmake (ubuntu-latest) (push) Failing after 5s
Cross / appimage (push) Failing after 47m39s
Build / docs (push) Has been cancelled
Build / test (x64, GleeBug) (push) Has been cancelled
Build / test (x64, TitanEngine) (push) Has been cancelled
Build / test (x86, GleeBug) (push) Has been cancelled
Build / test (x86, TitanEngine) (push) Has been cancelled
Build / package (push) Has been cancelled
Build / cmake (x64) (push) Has been cancelled
Build / cmake (x86) (push) Has been cancelled
Cross / cmake (windows-latest) (push) Has been cancelled
Format / format (push) Has been cancelled
Generate CHM index
2026-07-26 22:44:30 +02:00
..
_static
_templates
commands Quietly switch threads when following in call stack view 2026-07-16 13:18:45 +02:00
developers Update x64dbg trace file format documentation 2026-05-30 10:30:15 +00:00
gui
introduction str.streq - that doesn't exist, there is streq 2026-07-10 20:41:25 +05:00
.editorconfig
.gitignore Build x64dbg.chm in CI 2025-08-19 20:18:51 +02:00
.readthedocs.yaml
COMPILE-linux.md Msvc wine build x64 architecture (#3669) 2025-08-03 15:08:25 +02:00
conf.py Build x64dbg.chm in CI 2025-08-19 20:18:51 +02:00
genhhk.py Generate CHM index 2026-07-26 22:44:30 +02:00
hacks.css
index.rst Simplify licenses sections of the docs to use links instead 2025-08-18 01:45:17 +02:00
licenses.md Update API and Qt licence documentation 2025-08-26 17:52:06 +08:00
make.bat Build x64dbg.chm in CI 2025-08-19 20:18:51 +02:00
makechm.bat Generate CHM index 2026-07-26 22:44:30 +02:00
README.md Update documentation building instructions 2025-08-26 10:22:43 +00:00
requirements.txt
theme.js

docs

Documentation repository for x64dbg at Read the Docs.

Building

Run makechm.bat. It will build the .CHM help file.

When first building the .CHM help file, it automatically downloads python 2.7.18 portable and Microsoft HTML Help Compiler 4.74.8702 from GitHub. Then, 7z is used to extract the downloaded archive, so make sure 7-zip is installed, and 7z command can be accessed from the current directory.

Note: The following patch was applied:

Add relpath = relpath.replace(os.path.sep, '/') after C:\Python27\Lib\site-packages\recommonmark\transform.py line 63