added GitHub banner

Author: JarryShaw

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,54 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [master, ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [master]
+  schedule:
+    - cron: '0 2 * * 6'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        # We must fetch at least the immediate parents so that if this is
+        # a pull request then we can checkout the head.
+        fetch-depth: 2
+
+    # If this run was triggered by a pull request event, then checkout
+    # the head of the pull request instead of the merge commit.
+    - run: git checkout HEAD^2
+      if: ${{ github.event_name == 'pull_request' }}
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      # Override language selection by uncommenting this and choosing your languages
+      # with:
+      #   languages: go, javascript, csharp, python, cpp, java
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

doc/sphinx/requirements.txt

@@ -1,70 +1,26 @@
--i https://pypi.tuna.tsinghua.edu.cn/simple
---extra-index-url https://mirrors.sjtug.sjtu.edu.cn/pypi/web/simple
---extra-index-url https://pypi.org/simple
--e .
-aenum==2.2.4
+# sphinx
+Sphinx==3.2.1
 alabaster==0.7.12
-appnope==0.1.0 ; sys_platform == 'darwin'
-astroid==2.4.2
-autopep8==1.5.4
-babel==2.8.0
-backcall==0.2.0
-beautifulsoup4[html5lib]==4.9.1
-certifi==2020.6.20
-chardet==3.0.4
-decorator==4.4.2
-dictdumper==0.8.4.post2
-doc8==0.8.1
+Babel==2.8.0
+pytz==2020.1
 docutils==0.16
-dpkt==1.9.3
-html5lib==1.1
-idna==2.10
 imagesize==1.2.0
-ipython-genutils==0.2.0
-ipython==7.18.1
-isort==5.5.1
-jedi==0.17.2
-jinja2==3.0.0a1
-lazy-object-proxy==1.5.1
-lxml==4.5.2
-markupsafe==2.0.0a1
-mccabe==0.6.1
+Jinja2==2.11.2
+MarkupSafe==1.1.1
 packaging==20.4
-parso==0.8.0
-pbr==5.5.0
-pexpect==4.8.0 ; sys_platform != 'win32'
-pickleshare==0.7.5
-pockets==0.9.1
-prompt-toolkit==3.0.7
-ptyprocess==0.6.0
-py==1.9.0
-pycodestyle==2.6.0
-pygments==2.6.1
-pylint==2.6.0
-pyparsing==3.0.0a2
-pyshark==0.4.2.11
-pysocks==1.7.1
-pytz==2020.1
-requests[socks]==2.24.0
-restructuredtext-lint==1.3.1
-rstcheck==3.3.1
-scapy==2.4.4
+pyparsing==2.4.7
 six==1.15.0
+Pygments==2.7.1
+requests==2.24.0
+certifi==2020.6.20
+chardet==3.0.4
+idna==2.10
+urllib3==1.25.10
+setuptools==50.3.0
 snowballstemmer==2.0.0
-soupsieve==2.0.1
-sphinx==3.2.1
 sphinxcontrib-applehelp==1.0.2
 sphinxcontrib-devhelp==1.0.2
 sphinxcontrib-htmlhelp==1.0.3
 sphinxcontrib-jsmath==1.0.1
-sphinxcontrib-napoleon==0.7
 sphinxcontrib-qthelp==1.0.3
 sphinxcontrib-serializinghtml==1.1.4
-stevedore==3.2.1
-tbtrim==0.3.1
-toml==0.10.1
-traitlets==5.0.4
-urllib3==1.25.10
-wcwidth==0.2.5
-webencodings==0.5.1
-wrapt==1.12.1

doc/sphinx/source/conf.py

@@ -34,7 +34,7 @@
     'sphinx.ext.viewcode',
     'sphinx.ext.intersphinx',
     'sphinx.ext.autodoc', 'sphinx.ext.autodoc.typehints',
-    'sphinxcontrib.napoleon',
+    'sphinx.ext.napoleon',
     'sphinx.ext.todo',
 ]
 
@@ -99,6 +99,20 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+html_theme_options = {
+    'show_powered_by': False,
+    'github_user': 'JarryShaw',
+    'github_repo': 'pypcapkit',
+    'github_banner': True,
+    #'show_related': False,
+    #'note_bg': '#FFF59C',
+    #'travis_button': True,
+    #'codecov_button': True,
+}
+
 
 def maybe_skip_member(app, what: str, name: str, obj: object, skip: bool, options: dict):  # pylint: disable=unused-argument
     if '_abc_impl' in name:

mypy.ini

@@ -0,0 +1,12 @@
+[mypy]
+ignore_missing_imports = True
+disallow_untyped_defs = True
+disallow_incomplete_defs = True
+check_untyped_defs = True
+no_implicit_optional = True
+warn_redundant_casts = True
+warn_unused_ignores = True
+warn_unreachable = True
+strict_equality = True
+show_column_numbers = True
+show_error_codes = True