attachments/myst.yml at main · FutureFacts/attachments · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
version: 1
project:
  title: Attachments
  description: A Python library for processing and transforming file attachments with AI-friendly outputs
  keywords: [python, attachments, documents, ai, llm, processing]

  authors:
    - name: Maxime Rivest
      email: mrive052@gmail.com
      # orcid: 0000-0000-0000-0000
  github: https://github.com/MaximeRivest/attachments
  toc:
    - file: README.md
    - file: docs/demo.md
      title: Demo
    - title: Architecture
      children:
        - file: docs/architecture/architecture.md
          title: Architecture Guide
        - file: docs/architecture/type_dispatch_system.md
          title: Type Dispatch System
    - title: Extending and Contributing to Attachments
      children:
        - file: docs/extending_attachments/how_to_add_an_adapter.ipynb
          title: How to add an adapter
        - file: docs/extending_attachments/how_to_add_a_file_type.ipynb
          title: How to add a file type
        - file: docs/extending_attachments/adding_dsl_commands.md
          title: Adding DSL Commands
    - title: DSL Reference
      children:
        - file: docs/dsl_cheatsheet.md
          title: DSL Cheatsheet
    - title: Examples & Tutorials
      children:
        - file: docs/examples/how_to_load_and_morph.ipynb
          title: URL Morphing Tutorial
        - file: docs/examples/pptx_split_demo.ipynb
          title: PowerPoint Processing Demo
    #- title: AI tutorials with attachments
    #  children:
    #    - file: docs/examples/openai_attachments_tutorial.ipynb


site:
  title: Attachments Library
  actions:
    - title: View on GitHub
      url: https://github.com/MaximeRivest/attachments
  domains: [] # Add any custom domains here later
  options:
    base_url: /attachments
    logo_text: A simple python library and some AI tutorials # Text to display next to/as the logo
    # MyST parser extensions
    parse:
      myst_enable_extensions:
        - colon_fence
        - deflist
        - dollarmath
        - fieldlist
        - html_admonition
        - html_image
        - linkify
        - replacements
        - smartquotes
        - substitution
        - tasklist