Skip to content

Commit

Permalink
chore(build): auto-generate vimdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
astronvimbot committed Sep 19, 2024
1 parent 3d354f2 commit 8a9fa27
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 142 deletions.
72 changes: 0 additions & 72 deletions doc/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,6 @@ astroui API documentation

## astroui

AstroNvim UI Utilities

UI utility functions to use within AstroNvim and user configurations.

This module can be loaded with `local astro = require "astroui"`

copyright 2023
license GNU General Public License v3.0

### config


Expand Down Expand Up @@ -78,15 +69,6 @@ function astroui.setup(opts: AstroUIOpts)

## astroui.status.component

AstroNvim Status Components

Statusline related component functions to use with Heirline

This module can be loaded with `local component = require "astroui.status.component"`

copyright 2023
license GNU General Public License v3.0

### breadcrumbs


Expand Down Expand Up @@ -378,15 +360,6 @@ function astroui.status.component.virtual_env(opts?: table)

## astroui.status.condition

AstroNvim Status Conditions

Statusline related condition functions to use with Heirline

This module can be loaded with `local condition = require "astroui.status.condition"`

copyright 2023
license GNU General Public License v3.0

### aerial_available


Expand Down Expand Up @@ -681,15 +654,6 @@ function astroui.status.condition.treesitter_available(bufnr: integer|table)

## astroui.status.heirline

AstroNvim Status Heirline Extensions

Statusline related heirline specific extensions

This module can be loaded with `local astro_heirline = require "astroui.status.heirline"`

copyright 2023
license GNU General Public License v3.0

### buffer_picker


Expand Down Expand Up @@ -748,15 +712,6 @@ function astroui.status.heirline.tab_type(self: table, prefix?: string)

## astroui.status.hl

AstroNvim Status Highlighting

Statusline related highlighting utilities

This module can be loaded with `local hl = require "astroui.status.hl"`

copyright 2023
license GNU General Public License v3.0

### file_icon


Expand Down Expand Up @@ -848,15 +803,6 @@ function astroui.status.hl.mode_bg()

## astroui.status.init

AstroNvim Status Initializers

Statusline related init functions for building dynamic statusline components

This module can be loaded with `local init = require "astroui.status.init"`

copyright 2023
license GNU General Public License v3.0

### breadcrumbs


Expand Down Expand Up @@ -908,15 +854,6 @@ function astroui.status.init.update_events(opts: AstroUIUpdateEvent|AstroUIUpdat

## astroui.status.provider

AstroNvim Status Providers

Statusline related provider functions for building statusline components

This module can be loaded with `local provider = require "astroui.status.provider"`

copyright 2023
license GNU General Public License v3.0

### close_button


Expand Down Expand Up @@ -1441,15 +1378,6 @@ function astroui.status.provider.virtual_env(opts: table)

## astroui.status.utils

AstroNvim Status Utilities

Statusline related uitility functions

This module can be loaded with `local status_utils = require "astroui.status.utils"`

copyright 2023
license GNU General Public License v3.0

### build_provider


Expand Down
71 changes: 1 addition & 70 deletions doc/astroui.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*astroui.txt* For Neovim >= 0.9.0 Last change: 2024 September 03
*astroui.txt* For Neovim >= 0.9.0 Last change: 2024 September 19

==============================================================================
Table of Contents *astroui-table-of-contents*
Expand Down Expand Up @@ -168,14 +168,6 @@ astroui API documentation

ASTROUI *astroui-lua-api-astroui*

AstroNvim UI Utilities

UI utility functions to use within AstroNvim and user configurations.

This module can be loaded with `local astro = require "astroui"`

copyright 2023 license GNU General Public License v3.0


CONFIG ~

Expand Down Expand Up @@ -243,15 +235,6 @@ Setup and configure AstroUI

ASTROUI.STATUS.COMPONENT *astroui-lua-api-astroui.status.component*

AstroNvim Status Components

Statusline related component functions to use with Heirline

This module can be loaded with `local component = require
"astroui.status.component"`

copyright 2023 license GNU General Public License v3.0


BREADCRUMBS ~

Expand Down Expand Up @@ -576,15 +559,6 @@ require("astroui.status").component.git_branch()

ASTROUI.STATUS.CONDITION *astroui-lua-api-astroui.status.condition*

AstroNvim Status Conditions

Statusline related condition functions to use with Heirline

This module can be loaded with `local condition = require
"astroui.status.condition"`

copyright 2023 license GNU General Public License v3.0


AERIAL_AVAILABLE ~

Expand Down Expand Up @@ -906,15 +880,6 @@ require("astroui.status").condition.treesitter_available }

ASTROUI.STATUS.HEIRLINE *astroui-lua-api-astroui.status.heirline*

AstroNvim Status Heirline Extensions

Statusline related heirline specific extensions

This module can be loaded with `local astro_heirline = require
"astroui.status.heirline"`

copyright 2023 license GNU General Public License v3.0


BUFFER_PICKER ~

Expand Down Expand Up @@ -975,14 +940,6 @@ _return_ — the string of prefix with the type (i.e. “_active” or

ASTROUI.STATUS.HL *astroui-lua-api-astroui.status.hl*

AstroNvim Status Highlighting

Statusline related highlighting utilities

This module can be loaded with `local hl = require "astroui.status.hl"`

copyright 2023 license GNU General Public License v3.0


FILE_ICON ~

Expand Down Expand Up @@ -1083,14 +1040,6 @@ MODE_BG ~

ASTROUI.STATUS.INIT *astroui-lua-api-astroui.status.init*

AstroNvim Status Initializers

Statusline related init functions for building dynamic statusline components

This module can be loaded with `local init = require "astroui.status.init"`

copyright 2023 license GNU General Public License v3.0


BREADCRUMBS ~

Expand Down Expand Up @@ -1153,15 +1102,6 @@ require("astroui.status").init.update_events { "BufEnter", { "User", pattern =

ASTROUI.STATUS.PROVIDER *astroui-lua-api-astroui.status.provider*

AstroNvim Status Providers

Statusline related provider functions for building statusline components

This module can be loaded with `local provider = require
"astroui.status.provider"`

copyright 2023 license GNU General Public License v3.0


CLOSE_BUTTON ~

Expand Down Expand Up @@ -1733,15 +1673,6 @@ astroui.status.utils.stylize

ASTROUI.STATUS.UTILS *astroui-lua-api-astroui.status.utils*

AstroNvim Status Utilities

Statusline related uitility functions

This module can be loaded with `local status_utils = require
"astroui.status.utils"`

copyright 2023 license GNU General Public License v3.0


BUILD_PROVIDER ~

Expand Down

0 comments on commit 8a9fa27

Please sign in to comment.