docs abstraction & code formating (#17)

.github/workflows/doxygen.yml

@@ -28,7 +28,6 @@ jobs:
       uses: actions/checkout@v2
     - name: overwrite doxygen tags
       run: |
-        mkdir docs
         touch doxygenAction
         echo "PROJECT_NUMBER = ${{ steps.latest_ver.outputs.release }}" >> doxygenAction
         echo "@INCLUDE = doxygenAction" >> Doxyfile

.gitignore

@@ -1,2 +1,3 @@
-# ignore docs folder
-docs/
+# ignore doxygen generated files
+docs/html/
+docs/xml/

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "python.formatting.provider": "black"
+}

CONTRIBUTING.md

@@ -0,0 +1,9 @@
+These are the current requirements for getting your code included in RF24:
+
+* Try your best to follow the rest of the code, if you're unsure then the NASA C style can help as it's closest to the current style: https://ntrs.nasa.gov/archive/nasa/casi.ntrs.nasa.gov/19950022400.pdf
+
+* Definetly follow [PEP-8](https://www.python.org/dev/peps/pep-0008/) if it's Python code.
+
+* Follow the [Arduino IDE formatting style](https://www.arduino.cc/en/Reference/StyleGuide) for Arduino examples
+
+* Add [doxygen-compatible documentation](https://www.doxygen.nl/manual/docblocks.html) to any new functions you add, or update existing documentation if you change behaviour

Doxyfile

@@ -770,7 +770,8 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ./
+INPUT                  = ./ \
+                         ./docs/
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -867,7 +868,7 @@ EXCLUDE_SYMLINKS       = NO
 # Note that the wildcards are matched against the file with absolute path, so to
 # exclude all test directories for example use the pattern */test/*
 
-EXCLUDE_PATTERNS       =
+EXCLUDE_PATTERNS       = *README*
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the
@@ -952,7 +953,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE =
+USE_MDFILE_AS_MAINPAGE = ./docs/main_page.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing
@@ -2432,4 +2433,3 @@ GENERATE_LEGEND        = YES
 # This tag requires that the tag HAVE_DOT is set to YES.
 
 DOT_CLEANUP            = YES
-