diff options
Diffstat (limited to 'docs/website')
-rw-r--r-- | docs/website/tools/Makefile | 4 | ||||
-rw-r--r-- | docs/website/tools/g-ir-doc-tool.rst | 65 | ||||
-rw-r--r-- | docs/website/tools/index.rst | 4 |
3 files changed, 71 insertions, 2 deletions
diff --git a/docs/website/tools/Makefile b/docs/website/tools/Makefile index 6fb8baff..eb352eeb 100644 --- a/docs/website/tools/Makefile +++ b/docs/website/tools/Makefile @@ -1,6 +1,6 @@ # update man pages -all: ../../g-ir-compiler.1 ../../g-ir-generate.1 ../../g-ir-scanner.1 +all: ../../g-ir-compiler.1 ../../g-ir-doc-tool.1 ../../g-ir-generate.1 ../../g-ir-scanner.1 ../../%.1:%.rst rst2man $< > $@ @@ -8,4 +8,4 @@ all: ../../g-ir-compiler.1 ../../g-ir-generate.1 ../../g-ir-scanner.1 .PHONY: clean clean: - rm -f ../../g-ir-compiler.1 ../../g-ir-generate.1 ../../g-ir-scanner.1 + rm -f ../../g-ir-compiler.1 ../../g-ir-doc-tool.1 ../../g-ir-generate.1 ../../g-ir-scanner.1 diff --git a/docs/website/tools/g-ir-doc-tool.rst b/docs/website/tools/g-ir-doc-tool.rst new file mode 100644 index 00000000..535ca059 --- /dev/null +++ b/docs/website/tools/g-ir-doc-tool.rst @@ -0,0 +1,65 @@ +============= +g-ir-doc-tool +============= + +--------------------- +Documentation builder +--------------------- + +:Manual section: 1 + + +SYNOPSIS +======== + +**g-ir-doc-tool** [OPTION...] GIRFILE + + +DESCRIPTION +=========== + +g-ir-doc-tool builds library documentation directly from .gir files. The output +is adjusted according to which programming language you're generating docs for. + + +OPTIONS +======= + +--help + Show help options + +--output=DIRECTORY + Save the resulting output in DIRECTORY. + +--format=FORMAT + Output format. One of devdocs, mallard or sections. + +--language=LANGUAGE + Output language. One of c, python, or gjs. + +--add-include-path=DIRECTORY + Adds a directory which will be used to find includes inside the GIR format. + +--version + Show program's version number and exit + +--write-sections-file + Backwards-compatible equivalent to -f sections. + + +BUGS +==== + +Report bugs at https://gitlab.gnome.org/GNOME/gobject-introspection/issues + + +HOMEPAGE and CONTACT +==================== + +https://gi.readthedocs.io/ + + +AUTHORS +======= + +David King diff --git a/docs/website/tools/index.rst b/docs/website/tools/index.rst index 44897b6c..df56e804 100644 --- a/docs/website/tools/index.rst +++ b/docs/website/tools/index.rst @@ -8,12 +8,16 @@ Command Line Tools :maxdepth: 1 g-ir-compiler + g-ir-doc-tool g-ir-generate g-ir-scanner :doc:`g-ir-compiler` Typelib compiler +:doc:`g-ir-doc-tool` + Documentation builder + :doc:`g-ir-generate` Typelib generator |