feat: basic extension start

Author: machow

interlinks/.gitignore

@@ -0,0 +1,3 @@
+*.html
+*.pdf
+*_files/

interlinks/README.md

@@ -0,0 +1,30 @@
+# Interlinks Extension For Quarto
+
+_TODO_: Add a short description of your extension.
+
+## Installing
+
+_TODO_: Replace the `<github-organization>` with your GitHub organization.
+
+```bash
+quarto add <github-organization>/interlinks
+```
+
+This will install the extension under the `_extensions` subdirectory.
+If you're using version control, you will want to check in this directory.
+
+## Using
+
+_TODO_: Describe how to use your extension.
+
+## Example
+
+Here is the source code for a minimal example: [example.qmd](example.qmd).
+
+## Developing
+
+To see the AST the filter operates on, use this command:
+
+```
+quarto render example.qmd --to native --output -
+```

interlinks/_extensions/interlinks/_extension.yml

@@ -0,0 +1,7 @@
+title: Interlinks
+author: Michael Chow
+version: 1.0.0
+quarto-required: ">=1.2.0"
+contributes:
+  filters:
+    - interlinks.lua

interlinks/_extensions/interlinks/interlinks.lua

@@ -0,0 +1,85 @@
+inventory = {
+  mutate = 'https://siuba.org/api/verbs-mutate-transmute/',
+  ['plotnine.positions.position.position'] = 'someurl'
+}
+
+-- from https://stackoverflow.com/a/7615129/1144523
+function str_split (inputstr, sep)
+  if sep == nil then
+          sep = "%s"
+  end
+  local t={}
+  for str in string.gmatch(inputstr, "([^"..sep.."]+)") do
+          table.insert(t, str)
+  end
+  return t
+end
+
+
+-- Reformat all heading text
+function Header(el)
+  el.content = pandoc.Emph(el.content)
+  return el
+end
+
+
+function Code(el)
+  if el.attr.classes:find("ref") == nil then
+    return el
+  end
+
+  if el.text:find("^~") then
+    prefix = "~"
+    ref_name = el.text:sub(2)
+    splits = str_split(el.text, "%.")
+    out_name = splits[#splits]
+  else
+    prefix = ""
+    ref_name = el.text
+    out_name = el.text
+  end
+
+  dst = inventory[ref_name]
+  if dst ~=  nil then
+    return pandoc.Link(out_name, dst)
+  end
+
+  return el
+end
+
+function Pandoc(doc)
+  -- write your setup code here
+end
+
+function map(tbl, fn)
+    local result = {}
+    for k, v in pairs(tbl) do
+        result[k] = fn(v)
+    end
+    return result
+end
+
+local inventory = {}
+function Meta(meta)
+  for k, v in pairs(meta.interlinks.sources) do
+    print(k)
+    print(pandoc.utils.stringify(v.fallback))
+    local json = quarto.json.decode(read_file_contents(v.fallback))
+    for inv_k, inv_v in pairs(json.items) do
+        inventory[inv_v.name] = inv_v
+    end
+  end
+  quarto.utils.dump(inventory)
+
+end
+
+function read_file_contents(file)
+  local f = io.open(pandoc.utils.stringify(file), "r")
+  if f == nil then
+    error("Error resolving " .. target .. "- unable to open file " .. file)
+    os.exit(1)
+  end
+  local contents = f:read("*all")
+  f:close()
+  return contents
+end

interlinks/example.qmd

@@ -0,0 +1,23 @@
+---
+title: "Interlinks Example"
+filters:
+  - interlinks
+interlinks:
+  sources:
+    siuba:
+      url: https://siuba.org
+      inv: null 
+      fallback: objects_siuba.json
+---
+
+## Heading {#sec-hello}
+
+## Testing
+
+Tilde means don't display module:
+
+* `plotnine.positions.position.position`{.ref}
+* `~plotnine.positions.position.position`{.ref}
+* `some explanation <mutate>`{.ref}
+* `some explanation <siuba:siuba.dply.verbs.mutate>`{.ref}
+* [some explanation](siuba:siuba.dply.verbs.mutate)

interlinks/objects_siuba.json

@@ -0,0 +1,21 @@
+{
+  "project": "Siuba", "version": "0.4.2", "count": 2,
+  "items": [
+    {
+      "name": "siuba.dply.verbs.mutate",
+      "domain": "py",
+      "role": "function",
+      "priority": 0,
+      "uri": "api/verbs-mutate-transmute/",
+      "dispname": "-"
+    },
+    {
+      "name": "siuba.dply.verbs.summarize",
+      "domain": "py",
+      "role": "function",
+      "priority": 0,
+      "uri": "api/verb-summarize/",
+      "dispname": "-"
+    }
+  ]
+}

interlinks/objects_vetiver.inv

@@ -0,0 +1,5 @@
+# Sphinx inventory version 2
+# Project: vetiver
+# Version: 0.1.8
+# The remainder of this file is compressed using zlib.
+xڥWMo� ��+Fj�ި���ڨ�)U՛��k����/6v�
��)���
fǏ���Y��Ï����{%y+4t�ۺ���O�œ�B�������~�K�˲��-˞�(�A��ʚ��5�*<��\-������T���P���������f�A��ȦO�N��(�*;e,�u�*I���}��H���3�0�헝����W����d�{�;{��{�~���
�~!kl��z�9�Z;���Q�6=��IֶQ2ʷ���\t�����JJ�/e�.)�k6;���49��ԍ碒�D�sq�E~���Ĩ-h�1:�#R/�Ǿ[�}[P[,��%[U�{��;�6�pte]i�e��!M�Hr�/�q"-\��tc�<c�0�Y��y���������Z�#T���Y<.$0B�����13�t�;7�^�h��Ea�JHީFZ2�� M9�y��]�>`Q*ћ��UdH�UבI_W��t�,	W�����*~���L�7��Xu,Ǚ��[���7���!�85(���?�H1��A����$�˷�{!��˚w��������@���\�FغK1%<���#�"�YvqI�W��²`���x�Q�AF,n% �g�1��
��F,.���Y�UD�^P�1�C���� b�`&	�#b�sn�H��A<Dz�\)�ĀD����X��
�,C�)��v��fYqꍵ�0�P��o/D�j+����` ����������h���L)[{�K:���v�&�h�H�e�,o�i�+3�,#�Y�^�C(-�c����B2�U����!f�Kl�}3�M��7��Շ���1������f�
��3�

quartodoc.py

@@ -1,3 +1,5 @@
+import click
+
 from griffe.loader import GriffeLoader
 from griffe.docstrings.parsers import Parser, parse
 from griffe.docstrings import dataclasses as ds
@@ -11,6 +13,32 @@
 from typing import Tuple, Union
 
 
+@click.command()
+@click.option("--in-name", help="Name of input inventory file")
+@click.option("--out-name", help="Name of result (defaults to <input_name>.json)")
+def convert_inventory(in_name, out_name=None):
+    """Convert a sphinx inventory file to json."""
+    import json
+    import sphobjinv as soi
+
+    from pathlib import Path
+
+    if out_name is None:
+        out_name = Path(in_name).with_suffix(".json")
+
+    inv = soi.Inventory(in_name)
+
+    obj = inv.json_dict()
+
+    long = list(obj.items())
+    meta, entries = long[:3], [v for k, v in long[3:]]
+
+    out = dict(meta)
+    out["entries"] = entries
+
+    json.dump(out, open(out_name, "w"))
+
+
 def parse_function(module: str, func_name: str):
     griffe = GriffeLoader()
     mod = griffe.load_module(module)
@@ -183,7 +211,7 @@ def to_md(self, el: ds.DocstringParameter) -> Tuple[str]:
         if isinstance(el.annotation, str):
             annotation = el.annotation
         else:
-            annotation = el.annotation.full if el.annotation else None 
+            annotation = el.annotation.full if el.annotation else None
         return (escape(el.name), annotation, el.description, default)
 
     # examples ----
@@ -231,3 +259,7 @@ def to_md(self, el: ExampleText):
     )
     def to_md(self, el):
         raise NotImplementedError(f"{type(el)}")
+
+
+if __name__ == "__main__":
+    convert_inventory()