Skip to content

Commit c643e34

Browse files
committed
First try at adding documentation to the installer.
1 parent eb5f368 commit c643e34

File tree

4 files changed

+13
-7
lines changed

4 files changed

+13
-7
lines changed

Doc/Makefile

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
core = client ocr
44

55
all:
6-
@python docgen.py `echo $(core) | sed -r \
7-
's/(\w+)/..\/Units\/MMLCore\/\1.pas/g'` > /dev/null
8-
@make -C sphinx/ html
6+
# @python docgen.py `echo $(core) | sed -r \
7+
# 's/(\w+)/..\/Units\/MMLCore\/\1.pas/g'` > /dev/null
8+
@make -C sphinx/ singlehtml
99

1010
clean:
11-
@rm -f `echo $(core) | sed -r 's/(\w+)/sphinx\/\1.rst/g'`
11+
# @rm -f `echo $(core) | sed -r 's/(\w+)/sphinx\/\1.rst/g'`
1212
@make -C sphinx/ clean
1313

1414
tarball:
1515
@$(MAKE) all
16-
@tar cjf doc.tar.bz2 -C sphinx/_build/ html
16+
# @tar cjf doc.tar.bz2 -C sphinx/_build/ html

Documentation/README.txt

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
This is offline documentation shipped with your Simba release.
2+
3+
For up-to-date documentation see http://docs.villavu.com

Install/windows/Setup.iss

+3
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,9 @@ Source: "C:\Simba\Extensions\CRov.sex"; DestDir: "{app}\Extensions"; Flags: igno
4444
Source: "C:\Simba\Extensions\Updater.sei"; DestDir: "{app}\Extensions"; Flags: ignoreversion
4545
Source: "C:\Simba\Includes\mml.simba"; DestDir: "{app}\Includes"; Flags: ignoreversion
4646

47+
; Source: "C:\Simba\Doc\sphinx/_build/latex/Simba.pdf"; DestDir: "{app}\Documentation"; Flags: ignoreversion
48+
Source: "C:\Simba\Doc\sphinx/_build/singlehtml/index.html"; DestDir: "{app}\Documentation"; Flags: ignoreversion
49+
4750
; Source: "C:\Simba\Fonts\*"; DestDir: "{app}\Fonts"; Flags: ignoreversion recursesubdirs createallsubdirs
4851
; Source: "C:\Simba\Tests\PS\*"; DestDir:"{app}\Scripts\Tests"; Flags: ignoreversion
4952
; NOTE: Don't use "Flags: ignoreversion" on any shared system files

Projects/Simba/Makefile

+2-2
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ ifdef distrib
101101
#mv ../../Plugins ../../Plugins_bak
102102
#mkdir -p ../../Plugins
103103
#cp $(plugins_dir)/$(platform)/* ../../Plugins/
104-
7z a ../../$(binary).7z $(binary)$(binary_extension) ../../Extensions/ ../../Fonts/ ../../Includes/ ../../Plugins/ ../../Scripts
104+
7z a ../../$(binary).7z $(binary)$(binary_extension) ../../Extensions/ ../../Fonts/ ../../Includes/ ../../Plugins/ ../../Scripts ../../Documentation
105105
# now undo everything we did above
106106
#rm -rf ../../Plugins
107107
#mv ../../Plugins_bak ../../Plugins
@@ -131,7 +131,7 @@ all-in-one-distrib: all
131131
#mv ../../Plugins ../../Plugins_bak
132132
#mkdir -p ../../Plugins
133133
#cp $(plugins_dir)/all-in-one/* ../../Plugins/
134-
7z a ../../Simba.all-in-one.7z Simba.i386-* Simba.x86_64-* ../../Extensions/ ../../Fonts/ ../../Includes/ ../../Plugins/ ../../Scripts
134+
7z a ../../Simba.all-in-one.7z Simba.i386-* Simba.x86_64-* ../../Extensions/ ../../Fonts/ ../../Includes/ ../../Plugins/ ../../Scripts ../../Documentation
135135
# now undo everything we did above
136136
#rm -rf ../../Plugins
137137
#mv ../../Plugins_bak ../../Plugins

0 commit comments

Comments
 (0)