Improve pyproject.toml documentation and proposal
This commit is contained in:
parent
eb36b4e821
commit
c91fb8f2cb
17
README.org
17
README.org
@ -4339,7 +4339,8 @@ Listing [[lst:pyproject-toml-kickoff][kickoff pyproject.toml proposal]] facilita
|
||||
file into Python projects which anyhow should switch to using a [[https://pip.pypa.io/en/stable/reference/build-system/pyproject-toml][pyproject.toml]]
|
||||
file as explained in the post [[https://bbc.github.io/cloudfit-public-docs/packaging/this_way_up.html][This Way Up: A Bottom-Up Look At Python Packaging]].
|
||||
The [[https://packaging.python.org/en/latest/tutorials/packaging-projects/][packaging Python projects tutorial]] and the [[https://github.com/pypa/sampleproject][Python sample project]] walk you
|
||||
through the process of writing a [[https://pip.pypa.io/en/stable/reference/build-system/pyproject-toml][pyproject.toml]] file.
|
||||
through the process of writing a [[https://pip.pypa.io/en/stable/reference/build-system/pyproject-toml][pyproject.toml]] file. [[https://github.com/charliermarsh/ruff#does-ruff-support-numpy--or-google-style-docstrings][Ruff docstring setup]]
|
||||
explains how to setup documentation string checking in the [[https://pip.pypa.io/en/stable/reference/build-system/pyproject-toml][pyproject.toml]] file.
|
||||
|
||||
Listing [[lst:setup-cfg-kickoff][kickoff setup.cfg proposal]] implements the [[https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html][using black with other tools]]
|
||||
rules which make [[https://flake8.pycqa.org/en/latest/][flake8]] or [[https://pycodestyle.pycqa.org/en/latest/][pycodestyle]] agree with [[https://black.readthedocs.io/en/stable/index.html][black's uncompromising style]].
|
||||
@ -4534,10 +4535,12 @@ Complete the result with \"system\"."
|
||||
#+name: lst:pyproject-toml-kickoff
|
||||
#+begin_src toml :tangle pyproject.toml
|
||||
# [project]
|
||||
# name = "fancy-name"
|
||||
# name = "catchy-name"
|
||||
# version = "0.0.1"
|
||||
# description = "Catchy Acronym Description"
|
||||
|
||||
# [build-system]
|
||||
# requires = ["setuptools", "wheel"]
|
||||
# requires = [ "setuptools>=61.0" ]
|
||||
# build-backend = "setuptools.build_meta"
|
||||
|
||||
[tool.black]
|
||||
@ -4554,10 +4557,7 @@ select = [
|
||||
"F", # pyflakes
|
||||
# "W", # ruff emits no pycodestyle warnings yet
|
||||
]
|
||||
|
||||
ignore = [
|
||||
# https://www.pydocstyle.org/en/stable/error_codes.html#default-conventions
|
||||
# pydocstyle numpy convention:
|
||||
"D107", # ignore: missing docstring in __init__
|
||||
"D203", # ignore: single blank line required before class docstring
|
||||
"D212", # ignore: multi-line docstring summary should start at the first line
|
||||
@ -4572,8 +4572,11 @@ ignore = [
|
||||
[tool.ruff.mccabe]
|
||||
max-complexity = 15
|
||||
|
||||
[tool.ruff.pydocstyle]
|
||||
convention = "numpy"
|
||||
|
||||
# Local Variables:
|
||||
# mode: conf-toml
|
||||
# mode: conf-toml-mode
|
||||
# End:
|
||||
#+end_src
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user