BOSWatch/BW3-Core
1
0
Fork 0
mirror of https://github.com/BOSWatch/BW3-Core.git synced 2025-12-06 07:12:04 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

prepare for mkdocs docu

Browse source
This commit is contained in:
Bastian Schroll 2019-09-17 17:11:10 +02:00
parent 53a7d31797
commit 438dda48c2
6 changed files with 35 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
.gitignore vendored
View file

@ -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/

3
_info/requirements.txt
View file

@ -3,6 +3,9 @@
pyyaml
# for documentation generating
mkdocs
# for develope only
pytest
pytest-cov

17
docu/docs/index.md Normal file
View file

@ -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.

1
docu/mkdocs.yml Normal file
View file

@ -0,0 +1 @@
site_name: My Docs

2
test/test_template.py
View file

@ -29,7 +29,7 @@ def fixtureTemplate():
return None
@pytest.mark.skip
@pytest.mark.skip("Reason why i will skipped")
def test_skippedTest():
pass

8
test/testdata.list
View file

@ -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<NUL>
POCSAG1200: Address: 0871003 Function: 0 Alpha: B2 Feuer Gebäude Pers in Gefahr. bla bla bla<NUL>
# regEx-Filter?