👷 Add readthedocs

.gitignore

@@ -1,3 +1,5 @@
+_readthedocs/
+
 /cppjieba/
 /lua/jieba/dict/
 

.pre-commit-config.yaml

@@ -67,13 +67,13 @@ 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:
           - markdown-it-texmath
   - repo: https://github.com/pre-commit/mirrors-clang-format
-    rev: v19.1.3
+    rev: v19.1.5
     hooks:
       - id: clang-format
   - repo: https://github.com/lunarmodules/luacheck

.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

README.md

@@ -1,5 +1,6 @@
 # jieba.nvim
 
+[![readthedocs](https://shields.io/readthedocs/jieba-nvim)](https://jieba-nvim.readthedocs.io)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Freed-Wu/jieba.nvim/main.svg)](https://results.pre-commit.ci/latest/github/Freed-Wu/jieba.nvim/main)
 [![github/workflow](https://github.com/Freed-Wu/jieba.nvim/actions/workflows/main.yml/badge.svg)](https://github.com/Freed-Wu/jieba.nvim/actions)
 

config.ld

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

lua/jieba/config.lua

@@ -1,6 +1,8 @@
--- luacheck: ignore 112 113
+--- default config. See `lua vim.print(require"jieba.config")`.
 ---@diagnostic disable: undefined-global
+-- luacheck: ignore 112 113
 
+---get dirname
 ---@param dir string
 ---@return string
 local function dirname(dir)
@@ -11,6 +13,7 @@ local function dirname(dir)
     return result
 end
 
+---join two paths
 ---@param dir string
 ---@param file string
 ---@return string
@@ -21,6 +24,7 @@ local function joinpath(dir, file)
     return dir .. "/" .. file
 end
 
+---judge if OS is win32
 ---@return boolean
 local function has_win32()
     if vim then
@@ -35,12 +39,14 @@ local dict_dir = joinpath(
 )
 
 return {
+    --- if hmm is enabled
     hmm = true,
+    --- config for paths
     paths = {
-        dict_path = joinpath(dict_dir, "jieba.dict.utf8"),
-        model_path = joinpath(dict_dir, "hmm_model.utf8"),
-        user_dict_path = has_win32() and "nul" or "/dev/null",
-        idf_path = joinpath(dict_dir, "idf.utf8"),
-        stop_word_path = joinpath(dict_dir, "stop_words.utf8"),
+        dict_path = joinpath(dict_dir, "jieba.dict.utf8"), -- for dict
+        model_path = joinpath(dict_dir, "hmm_model.utf8"), -- for model
+        user_dict_path = has_win32() and "nul" or "/dev/null", -- for user dict
+        idf_path = joinpath(dict_dir, "idf.utf8"), -- for idf
+        stop_word_path = joinpath(dict_dir, "stop_words.utf8"), -- for stop words
     }
 }

lua/jieba/nvim/init.lua

@@ -1,5 +1,6 @@
--- luacheck: ignore 112 113
+--- copied from <https://github.com/neo451/jieba.nvim/>
 ---@diagnostic disable: undefined-global
+-- luacheck: ignore 112 113
 -- This code snippet is taken from [kkew3/jieba.vim] and is licensed under the MIT License.
 -- Original License Text:
 -- MIT License

lua/jieba/utils.lua

@@ -1,3 +1,4 @@
+--- copied from <https://github.com/neo451/jieba.nvim/>
 local M = {}
 -- local utf8 = require("lua-utf8")
 -- local utf8 = require("jieba.utf8")

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

@@ -13,6 +13,7 @@ mkShell {
     (luajit.withPackages (
       p: with p; [
         busted
+        ldoc
       ]
     ))
   ];