Noam Postavsky
eda83304af
only /italicize/ words completely in upper case
...
no /YAS/nippet
2013-11-28 23:35:32 -05:00
Noam Postavsky
f86529c96f
only crosslink exported symbols
2013-11-28 23:35:32 -05:00
Noam Postavsky
21914cfe32
yas--document-symbol: reindent
2013-11-28 23:35:32 -05:00
Noam Postavsky
46c378d738
format args in docstrings as =code=, not /italic/
2013-11-28 23:35:28 -05:00
Joao Tavora
4f27187477
refactor: removed extras and snippets tree, both point to submodules
2013-11-28 22:45:40 +00:00
Noam Postavsky
2c237cc311
check function doc before variable doc
...
This means functions shadow variables with the same name, but at least
that's better than listing functions with the documentation from the
variable! (That happened because the call to yas--document-symbols in
snippet-reference.org was prefering function values to variables, while
the yas--document-symbol was prefering variable doc to function doc).
2013-11-27 21:44:18 -05:00
Noam Postavsky
eaa3141402
fix docstring extraction for "fancy" docs
...
The docstrings for yas-expand and yas-expand-from-keymap are generated
on the fly, depending on how they are called ("context"). Add a context
argument to the synthesizing functions and pass it nil when extracting
docstrings for the manual.
2013-11-27 21:34:29 -05:00
Noam Postavsky
8d7c9a63a2
retrieve function documentation correctly
2013-11-27 21:04:26 -05:00
Noam Postavsky
fd3fa39444
publish org doc from Rakefile
2013-11-26 23:09:18 -05:00
Noam Postavsky
07b1d3925c
move #+STARTUP to org-setup.inc; add #+LINK_HOME
...
also remove #+AUTHOR since it ends up refering to the generator, not the
actual author.
2013-11-26 23:09:18 -05:00
Noam Postavsky
0aebb41aca
move top heading to title
...
and all the other headings one level up. Except for
snippet-reference.org; yas--document-symbols doesn't quite work right in
that case, fix it later.
2013-11-26 23:09:17 -05:00
Noam Postavsky
dfdb89c61c
remove erroneous #+BEGIN/END_QUOTE
...
pandoc decided to add those for some reason
2013-11-26 23:09:17 -05:00
Noam Postavsky
da9852a43f
{snippet-development,faq}.org: fixup pandoc output
...
- add source blocks
- fix links
- don't duplicate docstrings
- formatting
2013-11-26 23:09:17 -05:00
Noam Postavsky
63873e7d5a
snippet-menu.org: links, formatting, obsolete refs
2013-11-26 23:09:17 -05:00
Noam Postavsky
eaeb6ff7a9
more links to docstrings, don't repeat docstrings
2013-11-26 23:09:17 -05:00
Noam Postavsky
08a44b43dc
add code examples for snippet-expansion.rst
...
pandoc org -> rst drops them
2013-11-26 23:09:17 -05:00
Noam Postavsky
8f1fa089fb
replace obsolete refs
...
yas-trigger-key -> bind yas-expand
yas-mode-symbol -> call yas-activate-extra-mode
2013-11-26 23:09:17 -05:00
Noam Postavsky
2f7bb6c751
move images to the section they describe
2013-11-26 23:09:17 -05:00
Noam Postavsky
e46d9c7410
link to docstring ref; fix other links, formatting
2013-11-26 23:09:17 -05:00
Noam Postavsky
7b82424735
move index.org subsection into snippet-expansion.org
2013-11-26 23:09:16 -05:00
Noam Postavsky
fd8423cb63
fix links
2013-11-26 23:09:16 -05:00
Noam Postavsky
875ef77dfb
move index.org subsection into snippet-organization.org
...
This almost completely overwrites the existing snippet-organization.org
which was imported from snippet-organization.rst via pandoc.
2013-11-26 23:09:16 -05:00
Noam Postavsky
5acc976712
split symbol reference into separate file
2013-11-26 23:09:16 -05:00
Noam Postavsky
f6cace08f3
convert old rst manuals to org mode
...
This is just the initial conversion with pandoc, they still need to be
fixed up. Also define new org files as a project in yas-doc-helper.el.
2013-11-26 23:09:16 -05:00
Noam Postavsky
d451fef0ab
rename manual.org to index.org
2013-11-26 23:09:16 -05:00
Noam Postavsky
c7c65163e5
don't use link abbreviations
...
It's unnecessary indirection when there aren't multiple links to the
same site.
2013-11-26 23:09:16 -05:00
Noam Postavsky
8e8320fadb
remove reference to yas-trigger-key
2013-11-23 14:38:43 -05:00
Noam Postavsky
fdd550a698
Fix screencast link.
2013-11-23 14:20:50 -05:00
Noam Postavsky
b20f0a4270
fix exporting of doc strings for org manual
...
need to pass (1+ level) to yas--document-symbol
2013-11-23 13:31:38 -05:00
Noam Postavsky
bc4cfbbb04
yas/ -> yas-
2013-11-12 01:55:05 -05:00
Noam Postavsky
a4a7e5e31e
fix typo: .yas.parents -> .yas-parents
...
same as 8853127, for org
2013-11-12 01:47:46 -05:00
Noam Postavsky
f5457dfa33
Go back to org manual
2013-11-12 01:42:44 -05:00
dongxiong
88531271f1
Update manual.mdown
...
file name error
2013-10-03 12:09:26 +08:00
João Távora
636c01d34a
doc: finally decided to write the manual in markdown
...
will use same or similar doc helpers
2013-05-09 00:07:22 +01:00
Joao Tavora
c13abb7520
doc/yas-doc-helper.el: write documentation for "exported" symbols from docstrings
...
doc/manual.org: some tweaks, use new yas--document-symbols
2012-08-01 21:48:58 +01:00
João Távora
6b35140c72
a little bitt more work on the documentation
2012-07-23 00:33:55 +01:00
Joao Tavora
7a88722371
more formatting mostly
2012-05-30 18:47:57 +01:00
Joao Tavora
68b0bce76a
a little more work, but very little
2012-05-30 17:24:22 +01:00
Joao Tavora
bdcecc0fe5
using an org-mode readme, too
2012-05-07 16:07:44 +01:00
Joao Tavora
b0a986b761
removed executable permissions
2012-05-07 15:58:44 +01:00
Joao Tavora
9ab633bc4f
merged every org file into manual.org
2012-05-07 15:56:17 +01:00
João Távora
56b8887538
scaffolding for a doc revamp
2012-05-07 09:26:42 +01:00
Joao Tavora
fdf7582e33
Fix issue 187
2011-11-07 13:40:33 +00:00
Jim Myhrberg
09cc3eec21
Keep snippet vars definitions in a single format across all snippets and documentation.
...
The format is:
# var-name: value
Previously snippets used a mixture of the following formatting:
#var-name: value
#var-name : value
# var-name: value
# var-name : value
2011-11-03 20:51:31 +00:00
Joao Tavora
1a7b2e370d
update doc to reflect recent changes, needs reviewing badly
2011-10-31 18:10:17 +00:00
Joao Tavora
1bc5993a44
html files no longer checked in under /doc
2011-10-27 12:19:48 +01:00
capitaomorte
7fe4e84f91
more changes to the .yas-setup files and fix issue 129
2011-05-07 19:13:40 +00:00
capitaomorte
c11379e768
small adjustments
2010-03-08 07:50:20 +00:00
capitaomorte
69df357ae8
updated the faq with results from the tab key issue
2009-09-25 09:05:50 +00:00
capitaomorte
037f8fd3ee
* proof-reading the documentation
...
* added link to the new screencast
2009-09-24 15:59:45 +00:00
