Viewing documentation
Published 05 February 2013
By default, SQL Doc opens the documentation when it's finished generating. If you don't want SQL Doc to open the generated documentation automatically, clear the Open documentation on completion check box on the Generate Documentation dialog box.
SQL Doc creates your documentation in the folder you specify on the Generate Documentation dialog box.
Web pages (.html)
HTML documentation is created in a time-stamped subfolder. To view the documentation:
- for web pages created with frames, open the main.html file
- for web pages created without frames, open the index.html file
The navigation tree for the documentation uses JavaScript. Your web browser may restrict access to this content if JavaScript is disabled. For more information, see your web browser documentation.
Document (.docx or .doc)
To view the documentation, open the Project.docx or Project.doc file.
Help file (.chm)
To view the documentation, open the Project.chm file. The help is opened in the Microsoft HTML Help browser.
These files can't be opened across a network.
Portable Document Format (.pdf)
To view the documentation, open the Project.pdf file. The help is opened in PDF viewing software, such as Adobe Reader.
You can download the latest version of Adobe Reader from http://get.adobe.com/reader/
Markdown (.md)
Markdown format is designed for being committed into a repository - for example in github.com.
As this feature was introduced for SQL Doc 3.1 please let us know if you have any suggestions for improving the format.
