Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Re-organize to make plug-in auto-update compatible
* Added a Makefile that automates preparing ZIP files for http://www.vim.org * The Makefile generates README.html <- README.md and includes it in the ZIP * The ZIP files can be directly unpacked in ~/.vim/ to ease installation * Changed install instructions to download ZIP instead of individual files * Renamed `vimpythonindex` since it should be installed as ~/.vim/pyref/index * Renamed `create-index.py` to `spider.py` * The plug-in should now support automatic updates using `getscript.vim` * Support for exceptions imported from the `exceptions` module
- Loading branch information
Showing
7 changed files
with
131 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
OUTDOC=doc/README.html | ||
ZIPDIR := $(shell mktemp -d) | ||
ZIPFILE := $(shell mktemp -u) | ||
|
||
# NOTE: Make does NOT expand the following back ticks! | ||
VERSION=`grep '^" Version:' pyref.vim | awk '{print $$3}'` | ||
|
||
# The main rule builds a ZIP that can be published to http://www.vim.org. | ||
main: Makefile pyref.vim index spider.py $(OUTDOC) | ||
@echo "Creating \`pyref-$(VERSION).zip' .." | ||
@mkdir -p $(ZIPDIR)/plugin $(ZIPDIR)/pyref | ||
@cp pyref.vim $(ZIPDIR)/plugin | ||
@cp index $(OUTDOC) spider.py $(ZIPDIR)/pyref | ||
@cd $(ZIPDIR) && zip -r $(ZIPFILE) . >/dev/null | ||
@rm -R $(ZIPDIR) | ||
@mv $(ZIPFILE) pyref-$(VERSION).zip | ||
|
||
# This rule converts the Markdown README to HTML, which reads easier. | ||
$(OUTDOC): Makefile README.md | ||
@echo "Creating $(OUTDOC) .." | ||
@cat doc/README.header > $(OUTDOC) | ||
@markdown README.md >> $(OUTDOC) | ||
@cat doc/README.footer >> $(OUTDOC) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
</body> | ||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" | ||
"http://www.w3.org/TR/html4/strict.dtd"> | ||
<html> | ||
<head> | ||
<title>pyref.vim - Context-sensitive documentation for Python source code in Vim</title> | ||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | ||
<style type="text/css"> | ||
body { font-family: sans-serif; padding: 1em 30% 4em 1em; } | ||
a:link, a:visited { color: #000080; } | ||
a:hover, a:active { color: #8B0000; } | ||
pre, code, tt { font-family: Monaco, Consolas, monospace; } | ||
pre { margin-left: 2em; } | ||
code { background: #F6F6F6; padding: .1em .3em; } | ||
p { text-align: justify; line-height: 1.75em; } | ||
h1 { padding: 0 30% 0 0; } | ||
h2, h3 { border-bottom: 2px solid #F6F6F6; margin: 2em 0 -0.5em 0; padding-left: 0.5em; } | ||
hr { height: 0; border: none; border: 1px solid #F6F6F6; } | ||
</style> | ||
</head> | ||
<body> |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.