Skip to content

Bookset helps you have software documentation available offline to read in GNOME Devhelp

License

Notifications You must be signed in to change notification settings

gutierri/bookset

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Bookset

Bookset is a tool for building devhelp2 format documents available for consumption via Gnome DevHelp.

How does it work?

Basically, the tool downloads the source code and navigates to the documentation directory and executes the necessary scripts to build the documentation in HTML format with a devhelp2 index.

During the build, an adjustment is made to partially convert the Sphinx documentation to devhelp2 (currently, Sphinx's default support is the old devhelp standard).

The documentation is pre-configured in a file Makefile and stored in the packages folder.

Instalation

Installation is simple, but you must first have some packages installed:

  • Python3/pip
  • Python3 venv (debian: python3.11-venv)
  • GNU Make
  • Bash 4+
git clone https://github.com/gutierri/bookset.git && cd bookset

Build a documentation:

make -f packages/<name package>.mk all

Usage:

make -f packages/flask.mk install

About

Bookset helps you have software documentation available offline to read in GNOME Devhelp

Topics

Resources

License

Stars

Watchers

Forks