Skip to content

Commit 7485cff

Browse files
kristijanhusakkristijanhusak
committed
use lemmy-help to generate api docs
1 parent 806b8b9 commit 7485cff

File tree

6 files changed

+191
-211
lines changed

6 files changed

+191
-211
lines changed

‎.github/workflows/docgen.yml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,10 @@ jobs:
3838
with:
3939
neovim: true
4040
version: v0.7.0
41-
- name: Install mini.nvim
42-
uses: actions/checkout@v2
43-
with:
44-
repository: echasnovski/mini.nvim
45-
path: mini.nvim
41+
- name: Install lemmy-help
42+
run: |
43+
curl -Lq https://github.com/numToStr/lemmy-help/releases/latest/download/lemmy-help-x86_64-unknown-linux-gnu.tar.gz | tar xz
44+
echo "$PWD" >> $GITHUB_PATH
4645
- name: Generate api docs
4746
run: make api_docs
4847
- name: Commit changes

‎doc/orgmode_api.txt

Lines changed: 163 additions & 179 deletions
Original file line numberDiff line numberDiff line change
@@ -1,179 +1,163 @@
1-
==============================================================================
2-
------------------------------------------------------------------------------
3-
*OrgApi.load()*
4-
`OrgApi.load`({name})
5-
Parameters~
6-
{name} `(optional)` `(string|string[])` specific file names to return (absolute path). If ommitted, returns all loaded files
7-
Return~
8-
OrgFile|OrgFile[]
9-
10-
------------------------------------------------------------------------------
11-
*OrgApi.current()*
12-
`OrgApi.current`()
13-
Get current org buffer file
14-
Return~
15-
OrgFile
16-
17-
18-
==============================================================================
19-
------------------------------------------------------------------------------
20-
*OrgFile*
21-
`OrgFile`
22-
Class~
23-
{OrgFile}
24-
Fields~
25-
{category} `(string)` current file category name. By default only filename without extension unless defined via #+CATEGORY directive
26-
{filename} `(string)` absolute path of the current file
27-
{headlines} OrgHeadline[]
28-
{is_archive_file} `(boolean)`
29-
30-
------------------------------------------------------------------------------
31-
*OrgFile:reload()*
32-
`OrgFile:reload`()
33-
Return refreshed instance of the file
34-
Return~
35-
OrgFile
36-
37-
38-
==============================================================================
39-
------------------------------------------------------------------------------
40-
*OrgHeadline*
41-
`OrgHeadline`
42-
Class~
43-
{OrgHeadline}
44-
Fields~
45-
{title} `(string)` headline title without todo keyword, tags and priority. Ex. `* TODO I am a headline :SOMETAG:` returns `I am a headline`
46-
{line} `(string)` full headline line
47-
{todo_value} `(optional)` `(string)` todo keyword of the headline (Example: TODO, DONE)
48-
{todo_type} `(optional)` `(string)` | "'TODO'" | "'DONE'" | "''"
49-
{tags} `(string[])` List of own tags
50-
{deadline} `(Date|nil)`
51-
{scheduled} `(Date|nil)`
52-
{closed} `(Date|nil)`
53-
{dates} Date[] List of all dates that are not "plan" dates
54-
{position} Range
55-
{all_tags} `(string[])` List of all tags (own + inherited)
56-
{file} OrgFile
57-
{parent} `(OrgHeadline|nil)`
58-
{priority} `(string|nil)`
59-
{headlines} OrgHeadline[]
60-
61-
------------------------------------------------------------------------------
62-
*OrgHeadline:reload()*
63-
`OrgHeadline:reload`()
64-
Return updated version of headline
65-
Return~
66-
OrgHeadline
67-
68-
------------------------------------------------------------------------------
69-
*OrgHeadline:set_tags()*
70-
`OrgHeadline:set_tags`({tags})
71-
Set tags on the headline. This replaces all current tags with provided ones
72-
Parameters~
73-
{tags} `(string[])`
74-
Return~
75-
Promise
76-
77-
------------------------------------------------------------------------------
78-
*OrgHeadline:priority_up()*
79-
`OrgHeadline:priority_up`()
80-
Increase priority on a headline
81-
Return~
82-
Promise
83-
84-
------------------------------------------------------------------------------
85-
*OrgHeadline:priority_down()*
86-
`OrgHeadline:priority_down`()
87-
Decrease priority on a headline
88-
Return~
89-
Promise
90-
91-
------------------------------------------------------------------------------
92-
*OrgHeadline:set_priority()*
93-
`OrgHeadline:set_priority`({priority})
94-
Set specific priority on a headline. Empty string clears the priority
95-
Parameters~
96-
{priority} `(string)`
97-
Return~
98-
Promise
99-
100-
------------------------------------------------------------------------------
101-
*OrgHeadline:set_deadline()*
102-
`OrgHeadline:set_deadline`({date})
103-
Set deadline date
104-
Parameters~
105-
{date} `(optional)` `(Date|string|nil)` If ommited, opens the datepicker. Empty string removes the date. String must follow org date convention (YYYY-MM-DD HH:mm...)
106-
Return~
107-
Promise
108-
109-
------------------------------------------------------------------------------
110-
*OrgHeadline:set_scheduled()*
111-
`OrgHeadline:set_scheduled`({date})
112-
Set scheduled date
113-
Parameters~
114-
{date} `(optional)` `(Date|string|nil)` If ommited, opens the datepicker. Empty string removes the date. String must follow org date convention (YYYY-MM-DD HH:mm...)
115-
Return~
116-
Promise
117-
118-
119-
==============================================================================
120-
------------------------------------------------------------------------------
121-
*OrgAgenda*
122-
`OrgAgenda`
123-
Class~
124-
{OrgAgenda}
125-
126-
------------------------------------------------------------------------------
127-
Class~
128-
{OrgAgendaOptions}
129-
Fields~
130-
{filters} `(optional)` `(string)` see Filters to apply to the current view. See `:help orgmode-org_agenda_filter` for more information
131-
{from} `(optional)` `(string)` | Date
132-
{span} `(optional)` `(number)` | 'day' | 'week' | 'month' | 'year'
133-
134-
------------------------------------------------------------------------------
135-
*OrgAgenda.agenda()*
136-
`OrgAgenda.agenda`({options})
137-
Parameters~
138-
{options} `(optional)` OrgAgendaOptions
139-
140-
------------------------------------------------------------------------------
141-
Class~
142-
{OrgAgendaTodosOptions}
143-
Fields~
144-
{filters} `(optional)` `(string)` see Filters to apply to the current view. See `:help orgmode-org_agenda_filter` for more information
145-
146-
------------------------------------------------------------------------------
147-
*OrgAgenda.todos()*
148-
`OrgAgenda.todos`({options})
149-
Parameters~
150-
{options} `(optional)` OrgAgendaTodosOptions
151-
152-
------------------------------------------------------------------------------
153-
Class~
154-
{OrgAgendaTagsOptions}
155-
Fields~
156-
{filters} `(optional)` `(string)` see Filters to apply to the current view. See `:help orgmode-org_agenda_filter` for more information
157-
{todo_only} `(optional)` `(boolean)`
158-
159-
------------------------------------------------------------------------------
160-
*OrgAgenda.tags()*
161-
`OrgAgenda.tags`({options})
162-
Parameters~
163-
{options} `(optional)` OrgAgendaTagsOptions
164-
165-
166-
==============================================================================
167-
------------------------------------------------------------------------------
168-
*OrgPosition*
169-
`OrgPosition`
170-
Class~
171-
{OrgPosition}
172-
Fields~
173-
{start_line} `(number)` start line number
174-
{end_line} `(number)` end line number
175-
{start_col} `(number)` start column number
176-
{end_col} `(number)` end column number
177-
178-
179-
vim:tw=78:ts=8:noet:ft=help:norl:
1+
OrgApi.load({name?}) *OrgApi.load*
2+
3+
Parameters: ~
4+
{name?} (string|string[]) specific file names to return (absolute path). If ommitted, returns all loaded files
5+
6+
Returns: ~
7+
{OrgFile|OrgFile[]}
8+
9+
10+
OrgApi.current() *OrgApi.current*
11+
Get current org buffer file
12+
13+
Returns: ~
14+
{OrgFile}
15+
16+
17+
OrgFile *OrgFile*
18+
19+
Fields: ~
20+
{category} (string) current file category name. By default only filename without extension unless defined via #+CATEGORY directive
21+
{filename} (string) absolute path of the current file
22+
{headlines} (OrgHeadline[])
23+
{is_archive_file} (boolean)
24+
25+
26+
OrgFile:reload() *OrgFile:reload*
27+
Return refreshed instance of the file
28+
29+
Returns: ~
30+
{OrgFile}
31+
32+
33+
OrgHeadline *OrgHeadline*
34+
35+
Fields: ~
36+
{title} (string) headline title without todo keyword, tags and priority. Ex. `* TODO I am a headline :SOMETAG:` returns `I am a headline`
37+
{line} (string) full headline line
38+
{tags} (string[]) List of own tags
39+
{deadline} (Date|nil)
40+
{scheduled} (Date|nil)
41+
{closed} (Date|nil)
42+
{dates} (Date[]) List of all dates that are not "plan" dates
43+
{position} (Range)
44+
{all_tags} (string[]) List of all tags (own + inherited)
45+
{file} (OrgFile)
46+
{parent} (OrgHeadline|nil)
47+
{priority} (string|nil)
48+
{headlines} (OrgHeadline[])
49+
50+
51+
OrgHeadline:reload() *OrgHeadline:reload*
52+
Return updated version of headline
53+
54+
Returns: ~
55+
{OrgHeadline}
56+
57+
58+
OrgHeadline:set_tags({tags}) *OrgHeadline:set_tags*
59+
Set tags on the headline. This replaces all current tags with provided ones
60+
61+
Parameters: ~
62+
{tags} (string[])
63+
64+
Returns: ~
65+
{Promise}
66+
67+
68+
OrgHeadline:priority_up() *OrgHeadline:priority_up*
69+
Increase priority on a headline
70+
71+
Returns: ~
72+
{Promise}
73+
74+
75+
OrgHeadline:priority_down() *OrgHeadline:priority_down*
76+
Decrease priority on a headline
77+
78+
Returns: ~
79+
{Promise}
80+
81+
82+
OrgHeadline:set_priority({priority}) *OrgHeadline:set_priority*
83+
Set specific priority on a headline. Empty string clears the priority
84+
85+
Parameters: ~
86+
{priority} (string)
87+
88+
Returns: ~
89+
{Promise}
90+
91+
92+
OrgHeadline:set_deadline({date?}) *OrgHeadline:set_deadline*
93+
Set deadline date
94+
95+
Parameters: ~
96+
{date?} (Date|string|nil) If ommited, opens the datepicker. Empty string removes the date. String must follow org date convention (YYYY-MM-DD HH:mm...)
97+
98+
Returns: ~
99+
{Promise}
100+
101+
102+
OrgHeadline:set_scheduled({date?}) *OrgHeadline:set_scheduled*
103+
Set scheduled date
104+
105+
Parameters: ~
106+
{date?} (Date|string|nil) If ommited, opens the datepicker. Empty string removes the date. String must follow org date convention (YYYY-MM-DD HH:mm...)
107+
108+
Returns: ~
109+
{Promise}
110+
111+
112+
OrgAgenda *OrgAgenda*
113+
114+
115+
OrgAgendaFilter *OrgAgendaFilter*
116+
117+
Type: ~
118+
string
119+
120+
121+
OrgAgendaOptions *OrgAgendaOptions*
122+
123+
124+
OrgAgenda.agenda({options?}) *OrgAgenda.agenda*
125+
@field filters? OrgAgendaFilter
126+
@field from? string | Date
127+
@field span? number | 'day' | 'week' | 'month' | 'year'
128+
129+
Parameters: ~
130+
{options?} (OrgAgendaOptions)
131+
132+
133+
OrgAgendaTodosOptions *OrgAgendaTodosOptions*
134+
135+
136+
OrgAgenda.todos({options?}) *OrgAgenda.todos*
137+
@field filters? OrgAgendaFilter
138+
139+
Parameters: ~
140+
{options?} (OrgAgendaTodosOptions)
141+
142+
143+
OrgAgendaTagsOptions *OrgAgendaTagsOptions*
144+
145+
146+
OrgAgenda.tags({options?}) *OrgAgenda.tags*
147+
@field filters? OrgAgendaFilter
148+
@field todo_only? boolean
149+
150+
Parameters: ~
151+
{options?} (OrgAgendaTagsOptions)
152+
153+
154+
OrgPosition *OrgPosition*
155+
156+
Fields: ~
157+
{start_line} (number) start line number
158+
{end_line} (number) end line number
159+
{start_col} (number) start column number
160+
{end_col} (number) end column number
161+
162+
163+
vim:tw=78:ts=8:noet:ft=help:norl:

0 commit comments

Comments
 (0)