👷 Add readthedocs CI

Author: Freed-Wu

.pre-commit-config.yaml

@@ -53,7 +53,7 @@ repos:
     hooks:
       - id: yamllint
   - repo: https://github.com/executablebooks/mdformat
-    rev: 0.7.18
+    rev: 0.7.19
     hooks:
       - id: mdformat
         additional_dependencies:
@@ -67,7 +67,7 @@ repos:
           - mdformat-config
           - mdformat-web
   - repo: https://github.com/DavidAnson/markdownlint-cli2
-    rev: v0.15.0
+    rev: v0.16.0
     hooks:
       - id: markdownlint-cli2
         additional_dependencies:

.readthedocs.yaml

@@ -0,0 +1,12 @@
+# https://docs.readthedocs.io/en/stable/config-file/v2.html
+---
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3"
+  commands:
+    - pip install hererocks
+    - hererocks ~/lua -l5.1 -rlatest
+    - scripts/ldoc.sh

code-stats.nvim-scm-1.rockspec

@@ -33,5 +33,14 @@ end
 
 build = {
   type = 'builtin',
-  copy_directories = { 'plugin', 'assets', 'scripts' } ,
+  copy_directories = { 'plugin', 'assets' } ,
+  install = {
+    conf = {
+      ['..'] = 'shell.nix',
+      ['../scripts/update.sh'] = 'scripts/update.sh',
+      ['../scripts/get-OPENSSL_INCDIR.nix'] = 'scripts/get-OPENSSL_INCDIR.nix',
+      ['../scripts/get-OPENSSL_LIBDIR.nix'] = 'scripts/get-OPENSSL_LIBDIR.nix',
+      ['../scripts/get-STDCPP_LIBDIR.nix'] = 'scripts/get-STDCPP_LIBDIR.nix',
+    },
+  },
 }

config.ld

@@ -0,0 +1,7 @@
+---ldoc config
+-- luacheck: ignore 111
+---@diagnostic disable: lowercase-global
+project = "ime.nvim"
+readme = "README.md"
+format = "cmark"
+dir = "_readthedocs/html"

scripts/ldoc.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -e
+cd "$(dirname "$(dirname "$(readlink -f "$0")")")"
+
+. ~/lua/bin/activate &&
+  luarocks install ldoc &&
+  ldoc .

shell.nix

@@ -1,10 +1,18 @@
-{ pkgs ? import <nixpkgs> { } }:
+{
+  pkgs ? import <nixpkgs> { },
+}:
 
 with pkgs;
 mkShell {
   name = "code-stats.nvim";
   buildInputs = [
     stdenv.cc
     openssl
+    (luajit.withPackages (
+      p: with p; [
+        busted
+        ldoc
+      ]
+    ))
   ];
 }