https://github.com/vzhd1701/qt-documentation-chm-autoupdated

Qt Reference Documentation compiled into CHM format (auto updated)
https://github.com/vzhd1701/qt-documentation-chm-autoupdated

chm docs documentation manual qt qt5 reference

Last synced: 2 months ago
JSON representation

Qt Reference Documentation compiled into CHM format (auto updated)

• Host: GitHub
• URL: https://github.com/vzhd1701/qt-documentation-chm-autoupdated
• Owner: vzhd1701
• License: mit
• Created: 2020-03-16T14:43:41.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T05:12:26.000Z (over 2 years ago)
• Last Synced: 2025-02-02T02:22:41.765Z (3 months ago)
• Topics: chm, docs, documentation, manual, qt, qt5, reference
• Language: Python
• Homepage:
• Size: 43.9 KB
• Stars: 20
• Watchers: 5
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# qt-documentation-chm-autoupdated

[![Qt Docs Version](https://img.shields.io/github/v/release/vzhd1701/qt-documentation-chm-autoupdated?color=%230F&label=Qt%20Docs)](https://github.com/vzhd1701/qt-documentation-chm-autoupdated/releases/latest)

[![Qt Docs autobuild](https://github.com/vzhd1701/qt-documentation-chm-autoupdated/actions/workflows/qt_autobuild.yml/badge.svg)](https://github.com/vzhd1701/qt-documentation-chm-autoupdated/actions/workflows/qt_autobuild.yml)

[**Download Qt Documentation CHM 6.4.2**](https://github.com/vzhd1701/qt-documentation-chm-autoupdated/releases/latest)

This repository will be automatically updated after each official Qt release.

## Workflow

The basic idea is to use CI to download latest Qt Docs pre-built in HTML format from the [official SDK repository](https://download.qt.io/online/qtsdkrepository/windows_x86/desktop/) (*_src_doc_examples directories), convert them into CHM project using [qt-documentation-chm](https://github.com/vzhd1701/qt-documentation-chm), compile CHM file with Microsoft® HTML Help Compiler from [HTML Help Workshop](https://docs.microsoft.com/en-us/previous-versions/windows/desktop/htmlhelp/microsoft-html-help-downloads) and upload it as a new release for this repository.

## Helper scripts

### build_docs.sh

Builds the CHM file from the documentation of select Qt release

### get_qt_docs.py

```

usage: get_qt_docs.py [-h] (--latest-version | --docs-latest | --docs VERSION)

optional arguments:

  -h, --help        show this help message and exit

  --latest-version  get latest Qt version number

  --docs-latest     get list of URLs for latest version of Qt documentation archives

  --docs VERSION    get list of URLs for selected version of Qt documentation archives

```