73ef4ff3
 Hu Chunming
提交三方库
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
## Instructions for Documentation
There are different possible configurations when building the docs:
Option 1. Start out with single boost library, such as the one in this repository. A new boost-root directory is generated for you, next to the current repo, (in the location ../boost-root) and the docs are output to ../boost-root/libs/_name-of-this-repo_/doc/html
or
Option 2. You have already set up boost-root. The repo has already been placed in boost-root/libs/_name-of-this-repo_, and that's where you run the build. In that case, the docs are output in the current directory, such as _name-of-this-repo_/doc/html. The existing boost-root is used.
Either of the above choices are possible. The build scripts detect if they are being run from a boost-root or not.
In order to build the documentation, refer to the appropriate sections below:
## Linux
Run the linuxdocs.sh script which can be found in the doc/tools directory:
```
tools/linuxdocs.sh
```
## Mac OSX
Run the osxdocs.sh script which can be found in the doc/tools directory:
```
tools/osxdocs.sh
```
## Windows
Run the powershell script windowsdocs.ps1 which can be found in the doc/tools directory:
```
.\tools\windowsdocs.ps1
```
## Help Card
To edit the Help Card in `HelpCard.org`, use LibreOffice Draw and install the
following fonts:
- [Cairo](https://fonts.google.com/specimen/Cairo)
- [M+ 1M](https://www.fontsquirrel.com/fonts/m-1m)
|
