sync with pybind/cmake_example; update docs (#15)

* update, fix

* update docs

* fix version

Author: district10

.pre-commit-config.yaml

@@ -19,7 +19,7 @@ ci:
 repos:
 # Standard hooks
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.1.0
+  rev: v4.4.0
   hooks:
   - id: check-added-large-files
   - id: check-case-conflict
@@ -32,41 +32,36 @@ repos:
   - id: mixed-line-ending
   - id: requirements-txt-fixer
   - id: trailing-whitespace
-  - id: end-of-file-fixer
 
 # Black, the code formatter, natively supports pre-commit
 - repo: https://github.com/psf/black
-  rev: 22.3.0
+  rev: 23.1.0
   hooks:
   - id: black
     exclude: ^(docs)
 
-# Sort your imports in a standard form
-- repo: https://github.com/PyCQA/isort
-  rev: 5.11.5
+- repo: https://github.com/charliermarsh/ruff-pre-commit
+  rev: "v0.0.254"
   hooks:
-  - id: isort
+    - id: ruff
+      args: ["--fix", "--show-fixes"]
 
-# Upgrade older Python syntax
-- repo: https://github.com/asottile/pyupgrade
-  rev: v2.31.1
+# Checking static types
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: "v1.0.1"
   hooks:
-  - id: pyupgrade
-    args: ["--py36-plus"]
+    - id: mypy
+      files: "setup.py"
+      args: []
+      additional_dependencies: [types-setuptools]
 
 # Changes tabs to spaces
 - repo: https://github.com/Lucas-C/pre-commit-hooks
-  rev: v1.1.13
+  rev: v1.4.2
   hooks:
   - id: remove-tabs
     exclude: ^(docs|Makefile)
 
-- repo: https://github.com/PyCQA/flake8
-  rev: 3.9.2
-  hooks:
-  - id: flake8
-    additional_dependencies: [flake8-bugbear]
-
 # CMake formatting
 - repo: https://github.com/cheshirekow/cmake-format-precommit
   rev: v0.6.13

Makefile

@@ -23,7 +23,7 @@ build:
 docs_build:
 	mkdocs build
 docs_serve:
-	mkdocs serve
+	mkdocs serve -a 0.0.0.0:8088
 
 DOCKER_TAG_WINDOWS ?= ghcr.io/cubao/build-env-windows-x64:v0.0.1
 DOCKER_TAG_LINUX ?= ghcr.io/cubao/build-env-manylinux2014-x64:v0.0.1

README.md

@@ -1,15 +1,55 @@
-# Usage
+# cmake-example
+
+Online document: **[readthedocs](http://cmake-example.readthedocs.io/)**
+
+<!--intro-start-->
+
+## Usage
+
+Install:
 
 ```bash
 python3 -m pip install cubao_cmake_example # install from pypi
 python3 -c 'import cubao_cmake_example; print(cubao_cmake_example.add(1, 2))'
 ```
 
+CLI interface: (created with [python-fire](https://github.com/google/python-fire))
+
 ```bash
 python3 -m cubao_cmake_example add 1 2
 python3 -m cubao_cmake_example subtract 9 4
 ```
 
+Help:
+
+```bash
+$ python3 -m cubao_cmake_example --help
+INFO: Showing help with the command '__main__.py -- --help'.
+
+NAME
+    __main__.py
+
+SYNOPSIS
+    __main__.py GROUP | COMMAND
+
+GROUPS
+    GROUP is one of the following:
+
+     fire
+       The Python Fire module.
+
+COMMANDS
+    COMMAND is one of the following:
+
+     add
+       add(arg0: int, arg1: int) -> int
+
+     subtract
+       subtract(arg0: int, arg1: int) -> int
+
+     pure_python_func
+```
+
 ```bash
 $ python3 -m cubao_cmake_example pure_python_func --help
 INFO: Showing help with the command '__main__.py pure_python_func -- --help'.
@@ -30,21 +70,19 @@ FLAGS
     --arg3=ARG3
         Type: str
         Default: 'you shall not pass'
-```
 
-```bash
 $ python3 -m cubao_cmake_example pure_python_func --arg1=43234
 int: 43234, float: 3.14, str: you shall not pass
 ```
 
-See more examples at [cubao](https://github.com/cubao), e.g.:
+<!--intro-end-->
 
--   [pybind11-rdp](https://github.com/cubao/pybind11-rdp): C++ implementation
-    of the Ramer-Douglas-Peucker algorithm (binding to python via pybind11)
--   [concave_hull](https://github.com/cubao/concave_hull):  A very fast 2D concave hull algorithm, for python
+---
 
 # Make a release
 
+(We now use Github Workflow to release to pypi. Skip the rest if you don't want to manually compile wheels.)
+
 ## On linux
 
 Install docker then

cubao_cmake_example/__init__.py

@@ -1,5 +1,5 @@
-from pybind11_cubao_cmake_example import *  # noqa
-from pybind11_cubao_cmake_example import __version__  # noqa
+from pybind11_cubao_cmake_example import *  # noqa: F403
+from pybind11_cubao_cmake_example import __version__  # noqa: F401
 
 
 def pure_python_func(

cubao_cmake_example/__main__.py

@@ -1,4 +1,4 @@
-from cubao_cmake_example import *  # noqa
+from cubao_cmake_example import *  # noqa: F403
 
 if __name__ == "__main__":
     import fire

docs/about/release-notes.md

@@ -24,7 +24,7 @@ pip install -U cubao_cmake_example
 
 ---
 
-You can also checkout release on:
+You can also checkout releases on:
 
 -   GitHub: <https://github.com/cubao/cmake_example/releases>
--   pypi: <https://pypi.org/project/cubao-cmake-example>
+-   PyPi: <https://pypi.org/project/cubao-cmake-example>

docs/code.md

@@ -0,0 +1,44 @@
+# code
+
+GitHub: [cmake-example](https://github.com/cubao/cmake_example)
+
+## CMakeLists.txt
+
+```cmake
+{%
+   include-markdown "../CMakeLists.txt"
+   comments=false
+%}
+```
+
+## src/main.cpp
+
+```cpp
+{%
+   include-markdown "../src/main.cpp"
+   comments=false
+%}
+```
+
+## setup.py
+
+<details>
+  <summary>code</summary>
+
+```python
+{%
+   include-markdown "../setup.py"
+   comments=false
+%}
+```
+
+</details>
+
+## tests/test_basic.py
+
+```cpp
+{%
+   include-markdown "../tests/test_basic.py"
+   comments=false
+%}
+```

docs/index.md

@@ -9,48 +9,11 @@ with some modifications:
 -   release to pypi
 -   use markdown document
 
-## Usage
-
-Install:
-
-```bash
-python3 -m pip install cubao_cmake_example # install from pypi
-python3 -c 'import cubao_cmake_example; print(cubao_cmake_example.add(1, 2))'
-```
-
-CLI interface:
-
-```bash
-python3 -m cubao_cmake_example add 1 2
-python3 -m cubao_cmake_example subtract 9 4
-```
-
-Help:
-
-```bash
-$ python3 -m cubao_cmake_example pure_python_func --help
-INFO: Showing help with the command '__main__.py pure_python_func -- --help'.
-
-NAME
-    __main__.py pure_python_func
-
-SYNOPSIS
-    __main__.py pure_python_func <flags>
-
-FLAGS
-    --arg1=ARG1
-        Type: int
-        Default: 42
-    --arg2=ARG2
-        Type: float
-        Default: 3.14
-    --arg3=ARG3
-        Type: str
-        Default: 'you shall not pass'
-
-$ python3 -m cubao_cmake_example pure_python_func --arg1=43234
-int: 43234, float: 3.14, str: you shall not pass
-```
+{%
+   include-markdown "../README.md"
+   start="<!--intro-start-->"
+   end="<!--intro-end-->"
+%}
 
 <div class="text-center">
 <a href="https://github.com/cubao/cmake_example" class="btn btn-primary" role="button">Code on GitHub</a>
@@ -59,8 +22,4 @@ int: 43234, float: 3.14, str: you shall not pass
 
 ## Related
 
-More examples at [cubao](https://github.com/cubao), e.g.:
-
--   [pybind11-rdp](https://github.com/cubao/pybind11-rdp): C++ implementation
-    of the Ramer-Douglas-Peucker algorithm (binding to python via pybind11)
--   [concave_hull](https://github.com/cubao/concave_hull):  A very fast 2D concave hull algorithm, for python
+See more projects at [cubao](https://cubao.readthedocs.io).

docs/requirements.txt

@@ -1 +1,2 @@
-mkdocs>=1.3.0
+mkdocs==1.4.2
+mkdocs-include-markdown-plugin==4.0.3

mkdocs.yml

@@ -8,9 +8,12 @@ edit_uri: blob/master/docs/
 
 theme: readthedocs
 nav:
-    - Home: index.md
-    - About:
-        - Release Notes: about/release-notes.md
-        - License: about/license.md
+  - Home: index.md
+  - Code: code.md
+  - About:
+      - Release Notes: about/release-notes.md
+      - License: about/license.md
+plugins:
+  - include-markdown
 
-copyright: Copyright © line
+copyright: Copyright &copy; 2023 <a href="https://cubao.readthedocs.io">cubao team</a>.