[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] master fd3fa39 057/177: publish org doc from Rakefile
From: |
João Távora |
Subject: |
[elpa] master fd3fa39 057/177: publish org doc from Rakefile |
Date: |
Sat, 28 Mar 2015 15:40:48 +0000 |
branch: master
commit fd3fa394449da99b191e56eae35e4ad4db6679ee
Author: Noam Postavsky <address@hidden>
Commit: Noam Postavsky <address@hidden>
publish org doc from Rakefile
---
Rakefile | 12 +++++++-----
doc/yas-doc-helper.el | 47 +++++++++++++++++++++++++++++++++++------------
2 files changed, 42 insertions(+), 17 deletions(-)
diff --git a/Rakefile b/Rakefile
index b7eb238..0044d1c 100644
--- a/Rakefile
+++ b/Rakefile
@@ -54,11 +54,11 @@ task :release => [:package, 'doc:archive'] do
raise "Not implemented for github yet!"
end
-rule '.html' => '.rst' do |t|
- sh "doc/compile-doc.py #{t.source} > #{t.name}"
-end
desc "Generate document"
-task :doc => FileList['doc/*.rst'].ext('html')
+task :doc do
+ sh "#{$EMACS} -Q -L . --batch -l doc/yas-doc-helper.el" +
+ " -f yas--generate-html-batch"
+end
namespace :doc do
task :archive do
@@ -79,8 +79,10 @@ namespace :doc do
Dir.glob("doc/images/*").each do |file|
FileUtils.cp file, 'doc/gh-pages/images'
end
+ rev = `git rev-parse --verify HEAD`
Dir.chdir 'doc/gh-pages' do
- sh "git commit -a -m 'Automatic documentation update.'"
+ sh "git commit -a -m 'Automatic documentation update.\n\n" +
+ "From #{rev.chomp()}'"
sh "git push"
end
end
diff --git a/doc/yas-doc-helper.el b/doc/yas-doc-helper.el
index 4300597..67e5986 100755
--- a/doc/yas-doc-helper.el
+++ b/doc/yas-doc-helper.el
@@ -24,6 +24,12 @@
;;; Code:
+(eval-when-compile
+ (require 'cl))
+(require 'org)
+(require 'org-publish)
+(require 'yasnippet) ; docstrings must be loaded
+
(defun yas--document-symbol (symbol level)
(flet ((concat-lines (&rest lines)
(mapconcat #'identity lines "\n")))
@@ -94,18 +100,35 @@
;; This lets all the org files be exported to HTML with
;; `org-publish-current-project' (C-c C-e P).
-(progn
- (defvar yas--document-org-project-plist
- `(:style
- "<link rel='stylesheet' type='text/css' href='stylesheets/styles.css'/>"
- :base-directory ,default-directory
- :publishing-directory ,default-directory))
-
- (let ((project (assoc "yasnippet" org-publish-project-alist)))
- (if project
- (setcdr project yas--document-org-project-plist)
- (push `("yasnippet" . ,yas--document-org-project-plist)
- org-publish-project-alist))))
+
+(let* ((rev (or (with-temp-buffer
+ (when (eq (call-process "git" nil t nil
+ "rev-parse" "--verify" "HEAD") 0)
+ (buffer-string)))
+ yas--version))
+ (dir (if load-file-name (file-name-directory load-file-name)
+ default-directory))
+ (proj-plist
+ (list
+ :base-directory dir :publishing-directory dir
+ :html-postamble
+ (concat "<hr><p class='creator'>Generated by %c on %d from "
+ rev "</p>\n"
+ "<p class='xhtml-validation'>%v</p>\n")))
+ (project (assoc "yasnippet" org-publish-project-alist)))
+ (if project
+ (setcdr project proj-plist)
+ (push `("yasnippet" . ,proj-plist)
+ org-publish-project-alist)))
+
+(defun yas--generate-html-batch ()
+ (let ((org-publish-use-timestamps-flag nil)
+ (org-export-copy-to-kill-ring nil)
+ (org-confirm-babel-evaluate nil)
+ (make-backup-files nil))
+ (org-publish "yasnippet" 'force)))
+
+
(provide 'yas-doc-helper)
;;; yas-doc-helper.el ends here
- [elpa] master fd8423c 045/177: fix links, (continued)
- [elpa] master fd8423c 045/177: fix links, João Távora, 2015/03/28
- [elpa] master 7b82424 046/177: move index.org subsection into snippet-expansion.org, João Távora, 2015/03/28
- [elpa] master 3002594 037/177: Merge pull request #430 from npostavs/org-doc, João Távora, 2015/03/28
- [elpa] master 875ef77 044/177: move index.org subsection into snippet-organization.org, João Távora, 2015/03/28
- [elpa] master 2f7bb6c 048/177: move images to the section they describe, João Távora, 2015/03/28
- [elpa] master 8f1fa08 049/177: replace obsolete refs, João Távora, 2015/03/28
- [elpa] master 08a44b4 050/177: add code examples for snippet-expansion.rst, João Távora, 2015/03/28
- [elpa] master dfdb89c 054/177: remove erroneous #+BEGIN/END_QUOTE, João Távora, 2015/03/28
- [elpa] master eaeb6ff 051/177: more links to docstrings, don't repeat docstrings, João Távora, 2015/03/28
- [elpa] master 07b1d39 056/177: move #+STARTUP to org-setup.inc; add #+LINK_HOME, João Távora, 2015/03/28
- [elpa] master fd3fa39 057/177: publish org doc from Rakefile,
João Távora <=
- [elpa] master 2c237cc 060/177: check function doc before variable doc, João Távora, 2015/03/28
- [elpa] master eaa3141 059/177: fix docstring extraction for "fancy" docs, João Távora, 2015/03/28
- [elpa] master 8d7c9a6 058/177: retrieve function documentation correctly, João Távora, 2015/03/28
- [elpa] master 63873e7 052/177: snippet-menu.org: links, formatting, obsolete refs, João Távora, 2015/03/28
- [elpa] master e46d9c7 047/177: link to docstring ref; fix other links, formatting, João Távora, 2015/03/28
- [elpa] master 860858d 061/177: Merge pull request #436 from npostavs/autodoc-1, 2, João Távora, 2015/03/28
- [elpa] master f6cace0 042/177: convert old rst manuals to org mode, João Távora, 2015/03/28
- [elpa] master 21914cf 064/177: yas--document-symbol: reindent, João Távora, 2015/03/28
- [elpa] master f86529c 065/177: only crosslink exported symbols, João Távora, 2015/03/28
- [elpa] master 0aebb41 055/177: move top heading to title, João Távora, 2015/03/28