HTML Tidy  5.2.0
The HTACG Tidy HTML Project
README.md
Go to the documentation of this file.
1 Build Documentation
2 ===================
3 
4 In addition to hosting the http://api.html-tidy.org website, this repository
5 also includes our tool for generating the appropriate `quickref.html` file and
6 the Doxygen project for generating the full API reference. These can be used
7 independently of this website.
8 
9 Prerequisites
10 -------------
11 
12 ### tidy-html5
13 This repository requires a `tidy-html5` source repository from which to gather
14 information. In order for the build tool will work, you will have to ensure that
15 it is referencing a correct version of the repository.
16 
17 The `tidy-html5` directory must be install in parallel (at the same directory
18 level) is this repository.
19 
20 ### `xsltproc`
21 Our build tools require [`xsltproc`](http://xmlsoft.org/XSLT/xsltproc.html) to
22 transform Tidy's XML output into something that can be used in our
23 documentation. Please ensure it is in your `$PATH`.
24 
25 ### `doxygen`
26 Our build tools require [`doxygen`](http://www.stack.nl/~dimitri/doxygen/) to
27 generate the API Reference website from Tidy's headers. Please ensure it is in
28 your `$PATH`.
29 
30 ### `tidy`
31 Our build tool requires HTML Tidy, of course. When you use `build_docs.sh` you
32 can specify a complete path to the Tidy that you wish to use. If you don't
33 specify a path, then the tool will automatically try to check the required
34 `tidy-html5/build/cmake` directory (the default CMake build directory).
35 
36 
37 Build
38 -----
39 
40 From the `tidy-html5-doxygen/` directory, simply execute:
41 
42 `./build_docs.sh <tidypath>`
43 
44 The `<tidypath>` is optional as described in the prerequisites.
45 
46 Output will be put into `tidy-html5-doxygen/output/`.
47 
48 
49 Update the Website
50 ------------------
51 
52 If you want to update the website with the new documentation, that will have
53 to be performed manually. This is not automated in the build process because
54 we don't want to accidentally overwrite our existing files.
55 
56 ### Places the files
57 
58 First move or copy `output/quickref_x.x.x.html` and `output/tidylib_api_x.x.x/`
59 into this repository's root-level `tidy/` directory.
60 
61 ### Update the data source
62 
63 The website will be updated automatically from versions that are present in
64 `_data/api_versions.yml`. Simply update this file with a new version.
65 
66 Versions will be displayed on the page in the same order as they are in this
67 file, so it is suggested that you maintain the newest versions on top.
68 
69 Also keep in mind that links are generated automatically from the version
70 number. Please keep them simple instead of being creative and fancy!