You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The program `build.py` convert the markdown files under `src` to html and pdf and populates the `docs` dir with the generated documentation.
49
+
The program `build.py` convert the markdown files under `src` to html and pdf and populates the
50
+
`docs` dir with the generated documentation.
51
+
This script should be run from the top-level directory of this repository.
52
+
53
+
54
+
47
55
Requires Python 3.7 or higher, due to call to `subprocess.run`, kwarg `capture_output`.
48
56
+ 2 required arguments: <Major> <minor> Stan version, expecting 2 positive integer arguments, e.g. `2 28`
49
57
+ 2 optional arguments: <format> <document>. The output format is either `website` or `pdf`. The document name corresponds to the name of the `src` subdirectory or `all`.
50
58
51
59
52
60
**Build script examples**
53
61
54
-
*`python build.py 2 35` - creates directory `docs/2_42` as needed; populates it will all generated documentation.
55
-
*`python build.py 2 35 website` - builds the docs website in `docs/2_42`.
56
-
*`python build.py 2 35 pdf functions-reference` - builds only the pdf version of the Stan functions reference, resulting document is `docs/2_35/functions-reference-2_35.pdf`
57
-
*`python build.py 2 35 pdf all` - builds all pdfs from the Stan documentation set, resulting pdfs are in `docs/2_35`.
58
-
62
+
```sh
63
+
pwd# check that you're in the top-level directory of this repository, path should end in "/stan-dev/docs"
64
+
python build.py 2 35 # creates directory docs/2_35 as needed; populates it will all generated documentation
65
+
python build.py 2 35 website # builds the docs website in docs/2_35
66
+
python build.py 2 35 pdf functions-reference # builds only the pdf version of the Stan functions reference, resulting document is docs/2_35/functions-reference-2_35.pdf
67
+
python build.py 2 35 pdf all # builds all pdfs from the Stan documentation set, resulting pdfs are in docs/2_35
0 commit comments