updated docs and bump version · Brenden2008/note-python@35ec818 · GitHub
Skip to content

Commit 35ec818

Browse files
bsatrombsatrom
committed
updated docs and bump version
1 parent 91256e5 commit 35ec818

11 files changed

Lines changed: 98 additions & 31 deletions

File tree

‎.gitignore‎

Lines changed: 4 additions & 1 deletion

‎Doxyfile‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
#---------------------------------------------------------------------------
66
DOXYFILE_ENCODING = UTF-8
77
PROJECT_NAME = note-python
8-
PROJECT_NUMBER = v1.1.1
8+
PROJECT_NUMBER = v1.1.2
99
PROJECT_BRIEF = "Python library for communicating with the Blues Wireless Notecard over serial or I²C."
10-
PROJECT_LOGO =
10+
PROJECT_LOGO = assets/blues-wireless.png
1111
OUTPUT_DIRECTORY = docs
1212
CREATE_SUBDIRS = NO
1313
ALLOW_UNICODE_NAMES = NO
@@ -116,7 +116,6 @@ WARN_LOGFILE =
116116
# Configuration options related to the input files
117117
#---------------------------------------------------------------------------
118118
INPUT = notecard
119-
INPUT += README.md
120119
INPUT_ENCODING = UTF-8
121120
FILE_PATTERNS = *.c \
122121
*.cc \

‎docs/py_filter.sh‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/bin/bash
2+
source env/bin/activate
3+
4+
python3 -m doxypypy.doxypypy -a -c $1

‎notecard/card.py‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1-
"""card Fluent API Helper.
1+
"""card Fluent API Helper."""
2+
3+
##
4+
# @file card.py
5+
#
6+
# @brief card Fluent API Helper.
7+
#
8+
# @section description Description
9+
# This module contains helper methods for calling card.* Notecard API commands.
10+
# This module is optional and not required for use with the Notecard.
211

3-
This module contains helper methods for calling card.*
4-
Notecard API commands.
5-
"""
612
import notecard
713
from .validators import validate_card_object
814

‎notecard/env.py‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1-
"""env Fluent API Helper.
1+
"""env Fluent API Helper."""
2+
3+
##
4+
# @file env.py
5+
#
6+
# @brief env Fluent API Helper.
7+
#
8+
# @section description Description
9+
# This module contains helper methods for calling env.* Notecard API commands.
10+
# This module is optional and not required for use with the Notecard.
211

3-
This module contains helper methods for calling env.*
4-
Notecard API commands.
5-
"""
612
import notecard
713
from .validators import validate_card_object
814

‎notecard/file.py‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1-
"""file Fluent API Helper.
1+
"""file Fluent API Helper."""
2+
3+
##
4+
# @file file.py
5+
#
6+
# @brief file Fluent API Helper.
7+
#
8+
# @section description Description
9+
# This module contains helper methods for calling file.* Notecard API commands.
10+
# This module is optional and not required for use with the Notecard.
211

3-
This module contains helper methods for calling file.*
4-
Notecard API commands.
5-
"""
612
import notecard
713
from .validators import validate_card_object
814

‎notecard/hub.py‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1-
"""hub Fluent API Helper.
1+
"""hub Fluent API Helper."""
2+
3+
##
4+
# @file hub.py
5+
#
6+
# @brief hub Fluent API Helper.
7+
#
8+
# @section description Description
9+
# This module contains helper methods for calling hub.* Notecard API commands.
10+
# This module is optional and not required for use with the Notecard.
211

3-
This module contains helper methods for calling hub.*
4-
Notecard API commands.
5-
"""
612
import notecard
713
from .validators import validate_card_object
814

‎notecard/note.py‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1-
"""note Fluent API Helper.
1+
"""note Fluent API Helper."""
2+
3+
##
4+
# @file note.py
5+
#
6+
# @brief note Fluent API Helper.
7+
#
8+
# @section description Description
9+
# This module contains helper methods for calling note.* Notecard API commands.
10+
# This module is optional and not required for use with the Notecard.
211

3-
This module contains helper methods for calling note.*
4-
Notecard API commands.
5-
"""
612
import notecard
713
from .validators import validate_card_object
814

‎notecard/notecard.py‎

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,35 @@
1-
"""Main module for note-python.
1+
"""Main module for note-python."""
2+
3+
##
4+
# @mainpage Python Library for the Notecard
5+
#
6+
# @section intro_sec Introduction
7+
# This module contains the core functionality for running the
8+
# note-python library, including the main Notecard class, and
9+
# Serial and I2C sub-classes.
10+
#
11+
# @section dependencies Dependencies
12+
#
13+
# this library requires a physical connection to a Notecard over I2C or
14+
# Serial to be functional.
15+
# @section author Author
16+
#
17+
# Written by Ray Ozzie and Brandon Satrom for Blues Inc.
18+
# @section license License
19+
#
20+
# Copyright (c) 2019 Blues Inc. MIT License. Use of this source code is
21+
# governed by licenses granted by the copyright holder including that found in
22+
# the
23+
# <a href="https://github.com/blues/note-python/blob/master/LICENSE">
24+
# LICENSE
25+
# </a>
26+
# file.
27+
28+
##
29+
# @file notecard.py
30+
#
31+
# @brief Main module for note-python. Contains core library functionality.
232

3-
This module contains the core functionality for running the
4-
note-python library, including the main Notecard class, and
5-
Serial and I2C sub-classes.
6-
"""
733
import sys
834
import json
935
import time

‎notecard/validators.py‎

Lines changed: 6 additions & 1 deletion

0 commit comments

Comments
 (0)