# valadoc-org **Repository Path**: tangdk/valadoc-org ## Basic Information - **Project Name**: valadoc-org - **Description**: No description available - **Primary Language**: Unknown - **License**: LGPL-2.1 - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-05-14 - **Last Updated**: 2026-05-14 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Valadoc.org Stays crunchy, even in milk. This package contains build-tools used to generate valadoc.org and ideally shouldn't be used to generate other pages. Building ======== In order to build the docs you will need the following: * `valadoc` >= 0.35.0 * `php` * 4 GB of free space On elementary OS or Ubuntu run: ```bash sudo add-apt-repository ppa:vala-team sudo apt update sudo apt install valac valadoc libvaladoc-dev libjson-glib-dev unzip php php-curl ``` Arch or derivatives run: ```bash pacman -S vala php ``` Next, install JS dependencies: ```bash npm install ``` After you have `valadoc` installed, you can move to building the documentation. Simply run: ```bash make serve ``` This will take a bit of time, so grab yourself a cup of coffee; if you’re impatient, run: ```bash make serve-mini ``` for a minimal test version. If you encounter an error at this step, please see the [common pitfalls](#common-pitfalls) section. After you completed building, you should see a `valadoc.org` folder. To access the documentation navigate your browser to http://localhost:7777. Install locally =============== To install valadoc documentation as devhelp books, first build the pages with either ```bash make build-docs-mini build-data GENERATOR_OPTS=--skip-existing ``` for just glib, gio and gobject, or ```bash make build-docs build-data GENERATOR_OPTS=--skip-existing ``` for all packages. This can take a bit longer. After that you can run ```bash sudo make install ``` to install the devhelp books in your system. Now launch Devhelp and use them! Searching ========= For a more complete experience, you will need to install [manticore](https://manticoresearch.com/install/) and `xsltproc`. On elementary OS or Ubuntu run: ```bash sudo apt install xsltproc ``` The run the following command to generate search indexes: ```bash make serve-search ``` This will (eventually!) start a manticore daemon on port `51413`. Add New Packages ================ Open `documentation/packages.xml` and add a new package-entry. Use `` to create external links: ```xml short description ``` Use `` to build and include documentation for vapi files: ```xml short description ``` The following attributes are supported: | Name | Description | |-------------------|----------------------------------------------------| | name | The vapi name | | deprecated | Set it to '"true"' to mark a package as deprecated | | maintainers | List of binding maintainers | | gir | The GIR file used to extract documentation from | | c-docs | Link to C documentation | | ignore | Do not build documentation for this entry | | home | Homepage link | | flags | Additional vala flags (Missing dependencies, ...) | | gallery | Link to a GTK-Doc widget gallery | | vapi-image-source | Source to download images from | Referenced GIR and vapi-files have to be part of one of the following repositories: - [vala](http://vala-project.org/) - [vala-girs](https://github.com/nemequ/vala-girs) - [vala-extra-vapis](https://gitlab.gnome.org/GNOME/vala-extra-vapis) Add New Source Code Examples ============================ Copy your examples to `examples//` and add a new entry to `examples//.valadoc.examples`: ```xml Example Title optional-screenshot.png file-name-1.vala file-name-2.vala valac file-name1.vala file-name-2.vala ... Associated.Symbol.name1 Associated.Symbol.name2 ``` If this is the first example for the package, add a line to the `check-examples` target of `Makefile`. Add Handwritten Documentation ============================= Create a new file called `.valadoc` in `documentation//`: ``` ... /** * My valadoc comment */ c::c_symbol_name ``` ``` ... /** * My valadoc comment */ Vala.Symbol.Name ``` Tool Overview ============== - *generator:* Parses `packages.xml` files describing all packages. It is responsible for building up the page. It fetches resources such as images from specified sources, computes valadoc-calls, builds documentation for specified packages and puts-together the whole page. (`make serve`, `make serve-mini`) - *configgen:* Used to generate configuration files for our search index. - *valadoc-example-gen:* Internally used to generate example listings. - *valadoc-example-tester:* Compiles and checks all registered examples. (`make test-examples`) Common Pitfalls =============== `Uncaught Error: Class 'mysqli' not found` - Uncomment `extension=mysqli.so` in your OS's php.ini (`find /etc -name php.ini`) `error: failed to load driver` - Your valadoc version does not support the requested vala version. Install a recent vala version and recompile valadoc. - Change `VALAC_VERSION` in Makefile. Other errors: - Check `LOG` in the root of this repo for more information - Have you run out of disk space? Contact And Help ================= - [Homepage](http://www.valadoc.org), [GIT](https://github.com/vala-lang/valadoc-org) - [Issue Tracker, valadoc.org](https://github.com/vala-lang/valadoc-org/issues) - [Issue Tracker, valadoc (now a part of Vala)](https://gitlab.gnome.org/GNOME/vala/issues) - IRC: irc.gnome.org, #vala (flo, UTC+01:00) - Mail: flo.brosch@gmail.com