Skip to content

Commit 4360d52

Browse files
akaszynskiMaxJPReyPipKatjorgepiloto
authored
Add testing guide (#46)
* initial work * add file * add in testing guide * add CI sections * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/documentation_style/deployment.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/documentation_style/deployment.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/overview/dev_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/documentation_style/index.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Add poetry dependencies group for test. * Add link to poetry. * Coding style is not available. * Fix conflict of the deployment and docstring main hypertext. * Remove unexpected indentation. * Improve code sample rendering. * Add link for codecov.io. * Remove link for codecov.io CI Bot. * Add test_practices.rst. * Fix the link. * Update doc/source/documentation_style/index.rst * line wrapping; general cleanup * fix CI * Update doc/source/guidelines/test_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/guidelines/test_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/guidelines/test_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/guidelines/test_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/guidelines/test_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/guidelines/test_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * Update doc/source/guidelines/test_practices.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * End the sentence for the requirement files. * add testing methodology * Title underline was too short and prevented the doc to be buit. Co-authored-by: Maxime Rey <maxime.rey@ansys.com> Co-authored-by: Maxime Rey <87315832+MaxJPRey@users.noreply.github.com> Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> Co-authored-by: Jorge Martínez <28702884+jorgepiloto@users.noreply.github.com>
1 parent de08e17 commit 4360d52

5 files changed

Lines changed: 577 additions & 1 deletion

File tree

‎doc/source/documentation_style/deployment.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.. _documentation_deployment:
2+
3+
4+
Documentation Deployment
5+
------------------------
6+
Documentation for the PyAnsys project is hosted via `GitHub Pages <https://pages.github.com/>`_.
7+
Given the open-source nature of the project, documentation built by each PyAnsys library or
8+
project should be public and editable by users and the community at large.
9+
10+
After following the documentation build strategy contained within both
11+
the `pyansys/template <https://github.com/pyansys/template/>`_ and
12+
`pyansys-sphinx-theme
13+
<https://github.com/pyansys/pyansys-sphinx-theme>`_ you will end up
14+
with html documentation files in ``doc/build/html``.

‎doc/source/documentation_style/index.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,15 @@ The documentation for a PyAnsys library should contain:
2929
* Developer's guide for the library.
3030
* Link to this developer's guide.
3131

32+
Finally, the documentation should be public and hosted via gh-pages, either as
33+
a branch named ``gh-pages`` within the library repository or within a
34+
``gh-pages`` branch within ``<library-repository>-docs``. For more information,
35+
see :ref:`documentation_deployment`.
36+
3237
.. toctree::
3338
:hidden:
3439
:maxdepth: 3
3540

3641
docstrings
3742
class_documentation
43+
deployment

‎doc/source/guidelines/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ logging, data transfer, and application APIs.
1919
logging
2020
service_abstraction
2121
PyMAPDL_WSL_Guide
22-
22+
test_practices

0 commit comments

Comments
 (0)