diff --git a/.gitignore b/.gitignore index 34b3f9f..4933abe 100644 --- a/.gitignore +++ b/.gitignore @@ -6,12 +6,13 @@ # German BOS Information Script # by Bastian Schroll +# virtual environment +\.venv/ + +# generated files log/ _docu/ -_bin/win/zadig/ -_bin/win/rtl_sdr/ -_bin/win/multimon_1_1_1/ -_bin/win/kalibrate/ +docu/site/ # Logo Photoshop file *.psd @@ -22,6 +23,10 @@ _bin/win/kalibrate/ # Python precompiled *.pyc +# Visual Studio Code +\.vscode/ +\.pytest_cache/ + # PyCharm IDE \.cache/ \.idea/ diff --git a/_info/requirements.txt b/_info/requirements.txt index 5133ad3..795804f 100644 --- a/_info/requirements.txt +++ b/_info/requirements.txt @@ -3,6 +3,9 @@ pyyaml +# for documentation generating +mkdocs + # for develope only pytest pytest-cov diff --git a/docu/docs/index.md b/docu/docs/index.md new file mode 100644 index 0000000..d388039 --- /dev/null +++ b/docu/docs/index.md @@ -0,0 +1,17 @@ +# Welcome to MkDocs + +For full documentation visit [mkdocs.org](https://mkdocs.org). + +## Commands + +* `mkdocs new [dir-name]` - Create a new project. +* `mkdocs serve` - Start the live-reloading docs server. +* `mkdocs build` - Build the documentation site. +* `mkdocs help` - Print this help message. + +## Project layout + + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + ... # Other markdown pages, images and other files. diff --git a/docu/mkdocs.yml b/docu/mkdocs.yml new file mode 100644 index 0000000..c97182f --- /dev/null +++ b/docu/mkdocs.yml @@ -0,0 +1 @@ +site_name: My Docs diff --git a/test/test_template.py b/test/test_template.py index 6bc74ac..fdd28cd 100644 --- a/test/test_template.py +++ b/test/test_template.py @@ -29,7 +29,7 @@ def fixtureTemplate(): return None -@pytest.mark.skip +@pytest.mark.skip("Reason why i will skipped") def test_skippedTest(): pass diff --git a/test/testdata.list b/test/testdata.list index f4090b2..6b742c0 100644 --- a/test/testdata.list +++ b/test/testdata.list @@ -21,7 +21,7 @@ # # bitrate -POCSAG512: Address: 1000512 Function: 1 Alpha: BOSWatch-Test ÖÄÜß: okay +POCSAG512: Address: 1000512 Function: 1 Alpha: BOSWatch-Test ÖÄÜß: okay POCSAG1200: Address: 1001200 Function: 1 Alpha: BOSWatch-Test: okay POCSAG2400: Address: 1002400 Function: 1 Alpha: BOSWatch-Test: okay @@ -32,8 +32,8 @@ POCSAG512: Address: 1000002 Function: 2 Alpha: BOSWatch-Test: okay POCSAG512: Address: 1000003 Function: 3 Alpha: BOSWatch-Test: okay # german special sign -POCSAG512: Address: 1200001 Function: 1 Alpha: BOSWatch-Test ÖÄÜß: okay -POCSAG512: Address: 1200001 Function: 1 Alpha: BOSWatch-Test öäü: okay +POCSAG512: Address: 1200001 Function: 1 Alpha: BOSWatch-Test ÖÄÜß: okay +POCSAG512: Address: 1200001 Function: 1 Alpha: BOSWatch-Test öäü: okay # with csv POCSAG512: Address: 1234567 Function: 1 Alpha: BOSWatch-Test: with csv @@ -100,7 +100,7 @@ POCSAG1200: Address: 0860007 Function: 0 POCSAG1200: Address: 0860008 Function: 0 POCSAG1200: Address: 0860009 Function: 0 POCSAG1200: Address: 0860010 Function: 0 -POCSAG1200: Address: 0871003 Function: 0 Alpha: B2 Feuer Gebäude Pers in Gefahr. bla bla bla +POCSAG1200: Address: 0871003 Function: 0 Alpha: B2 Feuer Gebäude Pers in Gefahr. bla bla bla # regEx-Filter?