completing the switch to github pages for docs (#37)

* upadte docs badge in README

* try to fix mkdocs-deploy CI

* docs aren't only found in the docs folder

The python sources have the developer docs  embedded within comments.

* temporarily allow Ci to run on any branch

* also be sure to install docs requirements

* revert CI to only run on master branch

This is because I verified it works now

* Update .github/workflows/mkdocs-deploy.yml

Author: 2bndy5

.github/workflows/mkdocs-deploy.yml

@@ -3,8 +3,6 @@ name: MkDocs Deploy
 on:
   push:
     branches: [master]
-    paths:
-      - 'docs/**'
   workflow_dispatch:
 
 jobs:
@@ -15,8 +13,10 @@ jobs:
       - uses: actions/setup-python@v2
         with:
           python-version: 3.x
-      - run: pip install -r docs/requirements.txt
-      - run: |
+      - name: Install python action for doc extraction
+        run: pip install . -r docs/requirements.txt
+      - name: Build docs and deploy to gh-pages
+        run: |
           git config user.name 'github-actions'
           git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
           mkdocs gh-deploy --force

README.md

@@ -8,7 +8,7 @@
 ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/shenxianpeng/cpp-linter-action)
 [![cpp-linter](https://github.com/shenxianpeng/cpp-linter-action/actions/workflows/cpp-linter.yml/badge.svg)](https://github.com/shenxianpeng/cpp-linter-action/actions/workflows/cpp-linter.yml)
 ![GitHub](https://img.shields.io/github/license/shenxianpeng/cpp-linter-action?label=license)
-[![Dev Docs Status](https://readthedocs.org/projects/cpp-linter-action/badge/?version=latest)](https://cpp-linter-action.readthedocs.io/en/latest/?badge=latest)
+[![MkDocs Deploy](https://github.com/shenxianpeng/cpp-linter-action/actions/workflows/mkdocs-deploy.yml/badge.svg)](https://github.com/shenxianpeng/cpp-linter-action/actions/workflows/mkdocs-deploy.yml)
 [![open repo in gitpod](https://img.shields.io/badge/Gitpod-Use%20Online%20IDE-B16C04?logo=gitpod)](https://gitpod.io/#https://github.com/shenxianpeng/cpp-linter-action)
 
 A Github Action for linting C/C++ code integrating clang-tidy and clang-format to collect feedback provided in the form of thread comments and/or annotations.