Writing Documentation for Boost

From 75c737899a3ab056f707d8a32fb573173b43db55 Mon Sep 17 00:00:00 2001 From: Glen Fernandes Date: Tue, 19 May 2020 14:40:25 -0400 Subject: Move more to a new repository which will be a submodule of boost --- more/writingdoc/introduction.html | 68 --------------------------------------- 1 file changed, 68 deletions(-) delete mode 100644 more/writingdoc/introduction.html (limited to 'more/writingdoc/introduction.html') diff --git a/more/writingdoc/introduction.html b/more/writingdoc/introduction.html deleted file mode 100644 index 57387e1bc5..0000000000 --- a/more/writingdoc/introduction.html +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - - Writing Documentation for Boost - Introduction - - - - - - - - - -

- -	- Writing Documentation for Boost - - Introduction -

- -

Boost does not have any requirements on how you write your - documentation. If you are submitting a library that already has written - documentation in HTML format, there is no reason to change it to follow any - of the guidelines presented here. However, if you have documentation that's - not in HTML format and can't be easily converted to HTML, or if you're - starting on a library from scratch or have a library with no documentation - then these guidelines can make writing the documentation much easier.

- -

The section on Documentation Structure - describes how to go about structuring the documentation's content. This - section may be helpful even for libraries that already have documentation. - If there's a desire to present the library for possible inclusion by the - C++ Standards Committee then there may be a need to restructure the - documentation's content in order to insure the content meets explicit - requirements for library components (Section 17.3).

- -

The section on HTML Design gives general rules - to follow when writing HTML documentation in order to give a professional - and consistent look. This section also contains some template files that - can be used to rapidly create documentation pages.

- -

Revised - 04 - December, 2006

- -

Distributed under the Boost Software License, Version 1.0. (See - accompanying file LICENSE_1_0.txt or - copy at http://www.boost.org/LICENSE_1_0.txt)

- - -- cgit v1.2.1