Skip to content

Commit 073a62c

Browse files
authored
Add developer guide (#6)
* begin incorporating contributing * add style guide, dev guide * fix indendtation
1 parent dd09eb7 commit 073a62c

17 files changed

+1132
-7
lines changed

doc/source/coding_style/best_practices.rst

Lines changed: 713 additions & 0 deletions
Large diffs are not rendered by default.

doc/source/coding_style/flake8.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.. _style-guide-enforcement:
2+
3+
Style Guide Enforcement
4+
=======================

doc/source/coding_style/index.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.. _coding_style:
2+
3+
Coding Style
4+
************
5+
6+
The PyAnsys libraries are expected to follow `PEP8`_ will
7+
attempt to be consistent in style and formatting with the "big three"
8+
data science libraries: `NumPy`_, `SciPy`_, and `pandas`_.
9+
10+
.. _NumPy: https://numpy.org/
11+
.. _SciPy: https://www.scipy.org/
12+
.. _pandas: https://pandas.pydata.org/
13+
.. _PEP8: https://www.python.org/dev/peps/pep-0008/
14+
15+
16+
TODO:
17+
18+
* Describe flake8 standards (in subpage), include example ``.flake8``
19+
with minimum standards.
20+
* Include anythin we've written from other documentation either in
21+
this page or other pages.
22+
23+
.. toctree::
24+
:hidden:
25+
:maxdepth: 3
26+
27+
flake8
28+
best_practices
File renamed without changes.
File renamed without changes.
File renamed without changes.

doc/source/documentation/index.rst renamed to doc/source/documentation_style/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _api_documentation:
22

3-
API Documentation
4-
#################
3+
Documentation Style
4+
###################
55
Good documentation drives library adoption and usage and is the
66
foundation for a good developer experience. Even with the best
77
interfaces and the most functional product, no one will adopt the API

0 commit comments

Comments
 (0)