Skip to content

Add testing guide #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 65 commits into from
Feb 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
65 commits
Select commit Hold shift + click to select a range
813a9cf
initial work
akaszynski Dec 10, 2021
5d62fb2
add file
akaszynski Dec 10, 2021
216b4f5
add in testing guide
akaszynski Dec 30, 2021
f8afaec
add CI sections
akaszynski Feb 3, 2022
7d605b4
Merge branch 'main' into docs/add_doc_dep
MaxJPRey Feb 13, 2022
76cb757
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
1639d5a
Update doc/source/documentation_style/deployment.rst
MaxJPRey Feb 14, 2022
f14b6a2
Update doc/source/documentation_style/deployment.rst
MaxJPRey Feb 14, 2022
ffe0687
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
35a6271
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
9159638
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
4125ee9
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
5572012
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
3db01e8
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
52f6c28
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
fd7b191
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
e0b4039
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
16353bf
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
e761458
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
e96769b
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
1ee57c7
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
a556806
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
9ffd004
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
9219162
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
a97ee4b
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
320f7e8
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
2efa8d5
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
704865e
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
ff5d7d3
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
d4fa505
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
650adfd
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
a60a67c
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
98cd6b7
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
312bd65
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
184a34b
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
0c887fb
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
04888ef
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
e723f5a
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
6427db3
Update doc/source/overview/dev_practices.rst
MaxJPRey Feb 14, 2022
c285231
Update doc/source/documentation_style/index.rst
MaxJPRey Feb 14, 2022
90ce171
Add poetry dependencies group for test.
MaxJPRey Feb 14, 2022
ca85879
Merge.
MaxJPRey Feb 14, 2022
cbc568d
Add link to poetry.
MaxJPRey Feb 14, 2022
9d14bd0
Coding style is not available.
MaxJPRey Feb 14, 2022
69ff8d9
Fix conflict of the deployment and docstring main hypertext.
MaxJPRey Feb 14, 2022
02727b9
Remove unexpected indentation.
MaxJPRey Feb 14, 2022
06a9d1b
Improve code sample rendering.
MaxJPRey Feb 14, 2022
2123f4a
Add link for codecov.io.
MaxJPRey Feb 14, 2022
0396cd3
Remove link for codecov.io CI Bot.
MaxJPRey Feb 14, 2022
f11741a
Add test_practices.rst.
MaxJPRey Feb 14, 2022
4ad3469
Fix the link.
MaxJPRey Feb 15, 2022
a0ba114
Update doc/source/documentation_style/index.rst
jorgepiloto Feb 17, 2022
660591e
line wrapping; general cleanup
akaszynski Feb 17, 2022
5916deb
fix CI
akaszynski Feb 17, 2022
63ae117
Update doc/source/guidelines/test_practices.rst
MaxJPRey Feb 18, 2022
7348521
Update doc/source/guidelines/test_practices.rst
MaxJPRey Feb 18, 2022
92bf4db
Update doc/source/guidelines/test_practices.rst
MaxJPRey Feb 18, 2022
6dcbf9e
Update doc/source/guidelines/test_practices.rst
MaxJPRey Feb 18, 2022
96ad9a5
Update doc/source/guidelines/test_practices.rst
MaxJPRey Feb 18, 2022
7663139
Update doc/source/guidelines/test_practices.rst
MaxJPRey Feb 18, 2022
64d0207
Update doc/source/guidelines/test_practices.rst
MaxJPRey Feb 18, 2022
5706bf5
End the sentence for the requirement files.
MaxJPRey Feb 18, 2022
953ce59
add testing methodology
akaszynski Feb 19, 2022
104cc3f
merge upstream
akaszynski Feb 20, 2022
14c1915
Title underline was too short and prevented the doc to be buit.
MaxJPRey Feb 20, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions doc/source/documentation_style/deployment.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. _documentation_deployment:


Documentation Deployment
------------------------
Documentation for the PyAnsys project is hosted via `GitHub Pages <https://pages.github.com/>`_.
Given the open-source nature of the project, documentation built by each PyAnsys library or
project should be public and editable by users and the community at large.

After following the documentation build strategy contained within both
the `pyansys/template <https://github.com/pyansys/template/>`_ and
`pyansys-sphinx-theme
<https://github.com/pyansys/pyansys-sphinx-theme>`_ you will end up
with html documentation files in ``doc/build/html``.
6 changes: 6 additions & 0 deletions doc/source/documentation_style/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,15 @@ The documentation for a PyAnsys library should contain:
* Developer's guide for the library.
* Link to this developer's guide.

Finally, the documentation should be public and hosted via gh-pages, either as
a branch named ``gh-pages`` within the library repository or within a
``gh-pages`` branch within ``<library-repository>-docs``. For more information,
see :ref:`documentation_deployment`.

.. toctree::
:hidden:
:maxdepth: 3

docstrings
class_documentation
deployment
2 changes: 1 addition & 1 deletion doc/source/guidelines/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ Table of Contents
logging
service_abstraction
PyMAPDL_WSL_Guide

test_practices
Loading