db2html

package
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 17, 2023 License: AGPL-3.0 Imports: 16 Imported by: 0

Documentation

Overview

Package db2html creates HTML files from the docbook documenation.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DoThings

func DoThings(cfg *config.Config, manualname string, sitedoc bool) error

DoThings is the entry point to create the docbook based HTML manual

Types

type DocBook

type DocBook struct {
	Lang    string
	Version string
	// contains filtered or unexported fields
}

DocBook is the main structure for basic docbook 5 files

func ReadFile

func ReadFile(filename string, staticmode bool) (*DocBook, error)

ReadFile reads a Docbook 5 file and returns a docbook object and an error. If staticmode is true, then links will work in the browser without a server.

func (*DocBook) WriteHTMLFiles

func (d *DocBook) WriteHTMLFiles(basedir string) error

WriteHTMLFiles creates a directory and writes all HTML and static files used for the documentation

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL