Merge branch 'master' into allow-different-valac

Author: lewisgoddard

.dockerignore

@@ -22,6 +22,7 @@
 /valadoc-example-tester
 /node_modules/
 /yarn.lock
+/valadoc.org/
 
 !.babelrc
 !.editorconfig

.github/workflows/ci.yml

@@ -14,13 +14,13 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x]
+        node-version: [16.x, 18.x]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node-version }}
 
@@ -44,12 +44,12 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Install the dependencies
       run: |
         export DEBIAN_FRONTEND=noninteractive
-        curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
+        curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
         sudo apt-get update -y
         sudo apt-get install -y --no-install-recommends software-properties-common
         sudo add-apt-repository -y ppa:vala-team/daily
@@ -61,7 +61,7 @@ jobs:
         libgee-0.8-dev \
         git \
         libguestfs-gobject-dev \
-        libvaladoc-0.56-dev \
+        libvaladoc-0.58-dev \
         php \
         php-curl \
         sphinxsearch \

.github/workflows/publish.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Install the dependencies
         run: |
           export DEBIAN_FRONTEND=noninteractive
-          curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
+          curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
           sudo apt-get update -y
           sudo apt-get install -y --no-install-recommends software-properties-common
           sudo add-apt-repository -y ppa:vala-team/daily
@@ -31,7 +31,7 @@ jobs:
           libgee-0.8-dev \
           git \
           libguestfs-gobject-dev \
-          libvaladoc-0.56-dev \
+          libvaladoc-0.58-dev \
           php \
           php-curl \
           sphinxsearch \

Makefile

@@ -5,6 +5,9 @@ VALAC_VERSION := $(shell $(VALAC) --api-version | awk -F. '{ print "0."$$2 }')
 VAPIDIRS := --vapidir $(shell pkg-config --variable vapidir libvala-$(VALAC_VERSION)) --vapidir $(shell pkg-config --variable vapidir valadoc-$(VALAC_VERSION))
 VALAFLAGS = -g -X -w $(VAPIDIRS)
 PREFIX = "stable"
+INSTALL_DIR ?= /usr/local/share/devhelp/books
+
+.PHONY: install
 
 default: generator libdoclet.so update-girs configgen valadoc-example-gen valadoc-example-tester
 
@@ -133,6 +136,17 @@ serve-mini: build-docs-mini build-data
 
 serve-search: configgen
 	./configgen ./valadoc.org/
-	mkdir ./sphinx/storage
+	mkdir -p ./sphinx/storage
 	indexer --config ./sphinx.conf --all
 	searchd --config sphinx.conf
+
+.PHONY: install
+install:
+  $(shell mkdir -p $(INSTALL_DIR));
+  $(foreach package, $(shell ls ./valadoc.org/*/*.tar.bz2), $(shell tar -xf $(package) -C $(INSTALL_DIR));)
+
+#for package in `ls ./valadoc.org/*/*.tar.bz2`; do \
+#    echo $package; \
+#    tar -xf $package -C $INSTALL_DIR; \
+#  done; \
+

README.md

@@ -58,6 +58,26 @@ Using a different version of Vala
 You may want or need to test Valadoc with a different version of Vala, for example to pick up fixes in Vala that are necessary to build example code. You can do this with a chroot or jhbuild; or if your valac’s API version is different from other versions you have installed, just set `VALAC=valac-X.YY` in your environment when running `make`.
 
 
+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
 =========
 

data/index.php

@@ -79,7 +79,7 @@ function get_title ($page) {
     </form>
     <a class="title" href="/index.htm"><img alt="Valadoc" src="/images/logo.svg"/></a>
     <ul>
-      <li><a href="https://planet.vala-project.org/" target="_blank" title="Planet Vala"><i class="fa fa-globe"></i></a>
+      <li><a href="https://vala.dev/" target="_blank" title="Vala Official Website"><i class="fa fa-home"></i></a>
       <li><a href="https://www.reddit.com/r/vala/" target="_blank" title="reddit"><i class="fa fa-reddit"></i></a>
       <li><a href="/markup.htm" title="Markup Info"><i class="fa fa-info-circle"></i></a>
     </ul>

data/scripts/valadoc.js

@@ -71,6 +71,19 @@ function initTooltip() {
 
 
 function setupLink (link) {
+  let shouldTrackLink = false;
+
+  const xlinkPath = link.getAttribute('xlink:href');
+  
+  // Force tooltip to show up over `<a>` element nodes in SVGs.
+  if (xlinkPath && !link.getAttribute('href')) {
+    link.setAttribute('href', xlinkPath);
+    link.hostname = location.hostname;
+    // An SVGAnimatedString is returned when getting attributes from inside an SVG.
+    // We need to use the "baseVal` field to get the actual value  we need for the pathaname.
+    link.pathname = link.href.baseVal;
+  }
+
   if (link.hostname !== location.hostname
     || link.pathname.endsWith('index.htm')
     || link.pathname.endsWith('.tar.bz2')) {

data/styles/main.css

@@ -27,8 +27,8 @@ p {
 }
 
 /***********
- * Nav Bar *
- ***********/
+* Nav Bar *
+***********/
 
 nav {
     align-items: center;
@@ -115,8 +115,8 @@ nav .title img {
 }
 
 /***********
- * Sidebar *
- ***********/
+* Sidebar *
+***********/
 
 #sidebar {
     background-color: #f7f6f8;
@@ -138,7 +138,7 @@ nav .title img {
 }
 
 #sidebar .site_navigation a::before {
-    content: '';
+    content: "";
     display: inline-block;
     height: 16px;
     width: 16px;
@@ -183,7 +183,7 @@ nav .title img {
 
 #sidebar .external-link::after {
     background-image: url(/images/external_link.svg);
-    content: '';
+    content: "";
     display: inline-block;
     height: 12px;
     width: 12px;
@@ -249,7 +249,7 @@ nav .title img {
 
 .navi_inline li::before,
 .navi_main li::before {
-    content: '';
+    content: "";
     display: inline-block;
     height: 16px;
     width: 16px;
@@ -263,8 +263,8 @@ nav .title img {
 }
 
 /***********
- * Content *
- ***********/
+* Content *
+***********/
 
 #content-wrapper {
     display: flex;
@@ -315,7 +315,7 @@ nav .title img {
 .highlight .package::before,
 .document::before,
 .video::before {
-    content: '';
+    content: "";
     display: inline-block;
     height: 16px;
     width: 16px;
@@ -358,6 +358,19 @@ nav .title img {
     border-style: none;
     display: block;
     margin: 0 auto;
+    text-align: center;
+}
+
+.graph .node text {
+    font-size: 14px;
+}
+
+.graph > polygon {
+    fill: none;
+}
+
+.graph .node polygon {
+    fill: transparent;
 }
 
 .site_navi {
@@ -421,6 +434,7 @@ nav .title img {
     padding: 12px;
     text-align: left;
     z-index: 1000;
+    top: -200px;
 }
 
 .tooltip * {
@@ -634,8 +648,8 @@ code {
 }
 
 /*********
- * Icons *
- *********/
+* Icons *
+*********/
 
 .abstract_class::before,
 a.abstract_class,
@@ -792,3 +806,88 @@ a.abstract_class,
 .brief_description a.virtual_property {
     background-image: url(/images/virtualproperty.svg);
 }
+
+@media (prefers-color-scheme: dark) {
+    body {
+        background-color: #22222a;
+        color: #eee;
+    }
+
+    nav {
+        background-color: #38304c;
+    }
+
+    #sidebar {
+        background-color: #22222a;
+        border-right-color: #111;
+    }
+
+    #sidebar li:hover {
+        background-color: rgba(0, 0, 0, 0.5);
+    }
+    .search-selected {
+        background-color: #524a66 !important;
+    }
+
+    li.namespace::before,
+    li.package_index::before {
+        filter: brightness(200%);
+    }
+
+    #sidebar a {
+        color: #eee;
+    }
+
+    .highlight:hover {
+        background-color: #111;
+    }
+
+    #sidebar hr {
+        border-top-color: #222;
+        border-bottom-color: #000;
+    }
+
+    .main_code_definition {
+        background-color: #111;
+    }
+
+    .box .headline {
+        background-color: #112;
+        border-color: #446;
+    }
+
+    footer {
+        background-color: #1a1a1a;
+        color: #eee;
+    }
+
+    .graph .node polygon {
+        stroke: white;
+    }
+
+    .graph .node text {
+        fill: white;
+    }
+
+    .graph .edge path {
+        stroke: white;
+    }
+
+    .graph .edge polygon {
+        stroke: white;
+        fill: white;
+    }
+
+    .tooltip {
+        background-color: #111;
+    }
+
+    .main_parameter_table_unknown_parameter {
+        color: #999;
+    }
+
+    .main_table {
+        background: #335;
+        border: 1px solid #77c;
+    }
+}

documentation/glib-2.0/glib-2.0.valadoc

@@ -2569,10 +2569,11 @@ string.valid_char
 string.get
 
 /**
- * Replace all occurrences of the search string with the replacement string
+ * Replace occurrences of the search string with the replacement string at a maximum of max_tokens
  *
  * @param old The value being searched for
  * @param replacement The replacement value that replaces ``old`` values.
+ * @param max_tokens The maximum number. If this is less than 0, the string will be replaced completely.
  * @return a string with the replaced values. 
  */
 string.replace
@@ -3212,17 +3213,17 @@ GLib.FileStream.clearerr
 /**
  * Reads specified number of objects in the array buffer from the given input stream stream.
  * 
- * @param buffer pointer to the first object object in the array to be read
- * @param size the number of the objects to be read
+ * @param buf pointer to the first object object in the array to be read
+ * @param size the element's size, this is always sizeof(uint8) or 1
  * @return number of objects read successfully 
  */
 GLib.FileStream.read
 
 /**
  * Writes count of objects in the given array buffer to the output stream stream. 
  *
- * @param buffer pointer to the first object object in the array to be written
- * @param size the number of the objects to be written 
+ * @param buf pointer to the first object object in the array to be written
+ * @param size the element's size, this is always sizeof(uint8) or 1
  * @return number of objects written successfully
  */
 GLib.FileStream.write