Skip to content

Commit f33b89c

Browse files
author
Sergey Koshcheyev
committed
Documentation build reorganization. It now follows Hibernate directory structure closer.
SVN: trunk@1927
1 parent e89c60d commit f33b89c

File tree

806 files changed

+54981
-39467
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

806 files changed

+54981
-39467
lines changed

doc/HowToBuildTheDocumentation.txt

+7-17
Original file line numberDiff line numberDiff line change
@@ -9,28 +9,18 @@ This is the source files used to generate the NHibernate Documentation.
99
These files (in /doc/src/) are represented as DocBook (xml) files.
1010

1111
To build the documentation, you have to install some tools; and after that,
12-
you can simply run "Build.bat" (the result will be in /doc/build/).
13-
12+
you can simply run "Build.bat" (the result will be in
13+
/build/NHibernate-<version>/doc/).
1414

1515
================================================================================
1616
Required DLLs and EXEs
1717
================================================================================
18-
Download the files at ftp://ftp.zlatkovic.com/pub/libxml/ (or somewhere else ;)
19-
20-
Create a "tools" directory (you can use any directory).
21-
Add these files to the "tools" directory:
22-
23-
iconv.dll - from iconv-1.9.1.win32.zip
24-
libexslt.dll - from libxslt-1.1.12.win32.zip
25-
libxml2.dll - from libxml2-2.6.15.win32.zip
26-
libxslt.dll - from libxslt-1.1.12.win32.zip
27-
xmlcatalog.exe - from libxml2-2.6.15.win32.zip
28-
xmllint.exe - from libxml2-2.6.15.win32.zip
29-
xsltproc.exe - from libxslt-1.1.12.win32.zip
30-
zlib1.dll - from zlib-1.2.1.win32.zip
31-
32-
Add the "tools" directory to your %PATH% so the NAnt build file can use them.
18+
You need a Java Runtime Environment (JRE) to run Saxon which is used to build
19+
the documentation. You don't need to download and install Saxon, its jars are
20+
present in the repository.
3321

22+
You need HTML Help Workshop to build the CHM help file, and Visual Studio
23+
Help Integration Kit (VSHIK) to build the HtmlHelp2 help file.
3424

3525
================================================================================
3626
Quick Start

doc/chm_help.xsl

-16
This file was deleted.

doc/docbook-xml/ent/README

-14
This file was deleted.

doc/docbook-xml/ent/isoamsa.ent

-97
This file was deleted.

doc/docbook-xml/ent/isoamsb.ent

-83
This file was deleted.

doc/docbook-xml/ent/isoamsc.ent

-51
This file was deleted.

0 commit comments

Comments
 (0)