Skip to content
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

docs: add default structure for all test cases #1872

Merged
merged 32 commits into from
Feb 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
439929a
docs: add default structure for all test cases
AlexandraTrifan Jan 10, 2025
0c1715a
docs/tests: Added general dir to the default structure.
andreidanila1 Jan 10, 2025
3b8bdb8
docs/pqm: Changed the instrument labels.
andreidanila1 Jan 8, 2025
e63becf
docs/tests/general: Added core tests.
andreidanila1 Jan 8, 2025
9f6a729
docs/tests/plugins: Added PQM plugin tests.
andreidanila1 Jan 8, 2025
73e306a
test_cases:datalogger
IonutMuthi Dec 19, 2024
1608d96
docs: add initial test cases for the DAC plugin.
AlexandraTrifan Dec 20, 2024
65deb9a
docs: add initial migration of test cases for m2k and swiot
AlexandraTrifan Dec 20, 2024
351d5d7
test_cases:regmap
IonutMuthi Dec 18, 2024
9da6585
docs/tests: add install test cases and about page test cases
bindea-cristian Jan 21, 2025
da9f289
docs/tests: Add debugger tests
Andrei-Fabian-Pop Dec 13, 2024
ed0a9e5
docs/tests: Add tests for Debugger plugin
Andrei-Fabian-Pop Dec 19, 2024
498bb5a
docs/tests: Add tests for Debugger plugin preferences
Andrei-Fabian-Pop Dec 19, 2024
681f40d
docs/tests: Add tests for tool detach/atach
Andrei-Fabian-Pop Dec 19, 2024
fcb671c
docs/tests: Add tests for M2K Spectrum Analyzer
Andrei-Fabian-Pop Dec 19, 2024
1907801
docs/tests: Add tests for M2K Signal Generator
Andrei-Fabian-Pop Jan 13, 2025
b927bdf
docs/tests: Add tests for M2K Pattern Generator
Andrei-Fabian-Pop Dec 19, 2024
9d0b321
docs/tests: Add tests for M2K Voltmeter
Andrei-Fabian-Pop Dec 20, 2024
5b7cd89
docs/tests: Modify file structure to match design
Andrei-Fabian-Pop Jan 13, 2025
110efa4
docs/tests: Modify the test case structure
Andrei-Fabian-Pop Jan 20, 2025
740dde5
docs / tests: added adc and general preferences tests
andrei47w Jan 9, 2025
e6b44c1
docs / tests: fix adc and preferences tests
andrei47w Jan 23, 2025
7efa047
docs / tests: add prerequisites in adc and preferences
andrei47w Jan 28, 2025
4785910
docs / tests: change headers in adc tests
andrei47w Jan 28, 2025
4ccb647
docs/tests: rename tests and add missing information to all tests
AlexandraTrifan Jan 30, 2025
acb37c0
docs/tests: add test report structure to all the general module tests.
AlexandraTrifan Jan 30, 2025
99d325f
docs/tests: add test report structure to pqm, swiot, debugger, datalo…
AlexandraTrifan Jan 31, 2025
42342fa
docs/tests: add test report structure to the M2K plugin tests.
AlexandraTrifan Jan 31, 2025
ca9aea2
tests: reorganize the docs/tests folders and add index for each module.
AlexandraTrifan Feb 3, 2025
2c67bbe
docs/tests: add a testing guidelines document with detailed steps
AlexandraTrifan Feb 3, 2025
538349b
docs: generate tests reports in CI, based on all versions tested
AlexandraTrifan Feb 4, 2025
fe9686d
docs/tests: fix typos and add missing actual result.
AlexandraTrifan Feb 5, 2025
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
5 changes: 5 additions & 0 deletions .github/workflows/generate_doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ jobs:
pip install pip --upgrade
pip install -r requirements.txt

- name: Generate test report files
working-directory: docs
run: |
python3 tests/test_report_generator.py . ../testing_results/

- name: Build doc
working-directory: docs
run: |
Expand Down
2 changes: 1 addition & 1 deletion docs/developer_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Tutorials, coding guidelines and guides for developers.
.. note::

These guides are for Scopy v2.0.0 and future versions.
Follow the user guide for building Scopy an your local machine. Linux is recommended for development
Follow the user guide for building Scopy on your local machine. Linux is recommended for development

Contents
---------------------------------------------------------------------
Expand Down
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,12 @@ Contents

.. toctree::
:includehidden:
:maxdepth: 3
:maxdepth: 6

user_guide/index
plugins/index
developer_guide/index
tests/index


user_guide/preferences
Expand Down
8 changes: 4 additions & 4 deletions docs/plugins/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ Application Specific plugins
* :ref:`Faults <faults>`

* PQM
* :ref:`RMS <rms>`
* :ref:`Harmonics <harmonics>`
* :ref:`Waveform <waveform>`
* :ref:`Settings <settings>`
* :ref:`RMS <pqm-rms>`
* :ref:`Harmonics <pqm-harmonics>`
* :ref:`Waveform <pqm-waveform>`
* :ref:`Settings <pqm-settings>`


Contents
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/pqm/harmonics.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _harmonics:
.. _pqm-harmonics:

Harmonics
================================================================================
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/pqm/rms.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _rms:
.. _pqm-rms:

RMS
================================================================================
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/pqm/settings.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _settings:
.. _pqm-settings:

System settings
================================================================================
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/pqm/waveform.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _waveform:
.. _pqm-waveform:

Waveform
================================================================================
Expand Down
Loading
Loading