https://github.com/keithdhedger/docsets

Some doc sets for use with Zeal and other apps.
https://github.com/keithdhedger/docsets

api bash cpp development docset gtk2 gtk3 python qt5 qt6 zeal

Last synced: 4 months ago
JSON representation

Some doc sets for use with Zeal and other apps.

• Host: GitHub
• URL: https://github.com/keithdhedger/docsets
• Owner: KeithDHedger
• License: gpl-3.0
• Created: 2024-08-14T13:39:00.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-08-29T13:03:27.000Z (6 months ago)
• Last Synced: 2024-10-12T00:44:36.148Z (4 months ago)
• Topics: api, bash, cpp, development, docset, gtk2, gtk3, python, qt5, qt6, zeal
• Language: C++
• Homepage:
• Size: 331 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
DocSets


A number of different ways to create docsets for Zeal and other apps.


Although these will create usable docsets, these files are experimental.





GTKDocset:


Just run:

```console

./autogen.sh

cp -r *.docset ~/.local/share/Zeal/Zeal/docsets

```

XlibDocSet:


Just run:


```console

./makedocset

```

Files are automatically copied to~/.local/share/Zeal/Zeal/docsets


See the README.md file.








Qt5And6Docsets:


The 'official' qt5/6 docsets downloadable via zeal are out of date.

Just run:

```console

make install 2>/dev/null

```

Various options can be changed, see the Makefile.


The documentation will automatically be downloaded, if you already have the docs do ( obviously change the paths to suit ) eg:


```console

make install QT6DOCS=/usr/share/doc/qt6 QT5DOCS=/usr/share/doc/qt5 2>/dev/null

```

DocSetFromDevHelp:


To ( for instance ) create a docset from installed cairo gtk-docs with custom icon:


```console

DOCSET_NAME="cairo" SOURCEHTML=/usr/share/gtk-doc/html/cairo ICONPATH=/tmp/cairoicon.png ./createdocset

```

To ( for instance ) create a docset from installed harfbuzz gtk-docs, show entries and not installing:

```console

DOCSET_NAME="harfbuzz" SOURCEHTML=/usr/share/gtk-doc/html/harfbuzz DOCSETOP="/tmp/docs" VERBOSE=1 ./createdocset

```