File tree Expand file tree Collapse file tree 1 file changed +30
-0
lines changed Expand file tree Collapse file tree 1 file changed +30
-0
lines changed Original file line number Diff line number Diff line change @@ -14,3 +14,33 @@ Web-based documentation will be posted upon approval.
14
14
15
15
PDF version of this guide can be found in the release notes in `Releases
16
16
<https://github.com/pyansys/about/releases> `_.
17
+
18
+
19
+ Generate Documentation
20
+ ----------------------
21
+ Generate this documentation locally by first installing the
22
+ requirements with:
23
+
24
+ .. code ::
25
+
26
+ pip install -r requirements_docs.txt
27
+
28
+ Then build (on Windows) with:
29
+
30
+ .. code ::
31
+
32
+ cd doc
33
+ make.bat html
34
+
35
+ Or on Linux with:
36
+
37
+ .. code ::
38
+
39
+ make -C doc html
40
+
41
+
42
+ Contributing
43
+ ------------
44
+ Feel free to contribute to this guide by creating a branch and
45
+ contributing directly, or forking and submitting a PR. All PRs will
46
+ be reviewed before merge.
You can’t perform that action at this time.
0 commit comments