Skip to content

Latest commit

 

History

History

doc

README.md

Documentation

# ktch/doc
poetry run make html

dev notes

Conda

environment.ymlはconda向けの環境設定ファイル． poetry2condaを使って，pyproject.tomlから生成する方針にする．

# 出力を確認するとき
poetry run poetry2conda pyproject.toml -

# 生成するとき
poetry run poetry2conda pyproject.toml environment.yml

ライセンスの確認

liccheckを使っておこなう．

poetry export > requirements.txt
poetry run liccheck -s pyproject.toml

Release Please

prefix

  • fix: which represents bug fixes, and correlates to a SemVer patch.
  • feat: which represents a new feature, and correlates to a SemVer minor.
  • feat!:, or fix!:, refactor!:, etc., which represent a breaking change (indicated by the !) and will result in a SemVer major.

バージョンの変更

gitのcommit bodyにRelease-As: x.x.x（x.x.xは指定したいバージョン）と記載することで，そのバージョンのPRが作成される．

git commit --allow-empty -m "chore: 🔧 release x.x.x" -m "Release-As: x.x.x"

Licese

The documentations are licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) License.

The documentation system may also include some components licensed under open source licenses.

scikit-learn

The following items forked from scikit-learn are licensed under the BSD 3-Clause License.

  • shinxext/override_pst_pagetoc.py
  • _templates/base.rst