Here's how to compile Godot Documentation to CHM

This is a READ-ONLY snapshot of the Godot Community Forums when TwistedTwigleg was the owner, which is hosted for archival reasons only. The current Godot Community Forums can be found here.

Some links may point to external websites, including the current Godot Community Forums. These websites are not associated with TwistedTwigleg.

Here's how to compile Godot Documentation to CHM

Ahmed94

You'll need to follow same steps as compiling to HTML but you'll have to change some few steps

First of all .. open conf.py using a text editor (like notepad++) and delete this part (MOST IMPORTANT)

on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org

on_rtd = os.environ.get('READTHEDOCS', None) == 'True'

import sphinx_rtd_theme html_theme = 'sphinx_rtd_theme' html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] if on_rtd: using_rtd_theme = True

follow the same steps to compile godot documentation explained in github page but use this code to compile:

sphinx-build -b htmlhelp ./ build instead of this code: sphinx-build -b html ./ build (Notice that you may receive many warnings during compilation but these are something to be ignored)

Finally .. download Html Help Workshop from Microsoft page, open the hhp file and build it (as easy as I don't need to explain how to do it )

If things went well, Here's how the final file should appear: "v3.1 on Zippyshare"

Thanks in advance for taking your time :)

cybereality

Thanks for putting this together.

I was able to open the file and check it out with xchm on Linux, though there were some missing characters here and there, maybe because of the app I'm using or just something with Linux.

Also, can I ask what the use case is for this? Maybe if you are without internet or something.

Ahmed94

@cybereality said: Thanks for putting this together.

I was able to open the file and check it out with xchm on Linux, though there were some missing characters here and there, maybe because of the app I'm using or just something with Linux.

Also, can I ask what the use case is for this? Maybe if you are without internet or something.

I tried this on windows and had no problems so, maybe this happens with linux? I'm not familiar with linux tbh :(
imo, It's better to compress the whole tutorial documentation into one file rather than many files when compiled to html.

Calinou

~~Note that you can also download compiled HTML documentation here (as a ZIP archive).~~

Edit (2021-06-11): Official HTML builds are now provided on the documentation main page: https://docs.godotengine.org/en/stable/