Skip to content

Commit 335b313

Browse files
committed
add contributing and building guidelines
1 parent 226a918 commit 335b313

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,33 @@ Web-based documentation will be posted upon approval.
1414

1515
PDF version of this guide can be found in the release notes in `Releases
1616
<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.

0 commit comments

Comments
 (0)