15eafeb80a
build: Migrate from setup.py to pyproject.toml
...
Using `setup.py` is deprecated and the new recommanded way is to declare
a `pyproject.toml` file (see PEP 517 [^1]).
This commit proposes to use setuptools to achieve that, because
setuptools is already used by yamllint, is standard and referenced by
the official Python packaging documentation [^2], and seems to be the
most lightweight solution. An alternative could have been to use Poetry,
see the dedicated pull request and discussion [^3].
For some period, the `setup.py` file will be kept (although almost
empty), to allow old tools versions to keep working.
Closes https://github.com/adrienverge/yamllint/issues/509 .
[^1]: https://peps.python.org/pep-0517/
[^2]: https://packaging.python.org/en/latest/tutorials/installing-packages/
[^3]: https://github.com/adrienverge/yamllint/pull/557
2 years ago
6bfd6756e2
docs: Update links that redirect
2 years ago
cb5fe2c050
add OpenBSD installation instructions.
6 years ago
930c8eea94
docs: Simplify installation instruction in the README
6 years ago
f66661e36d
docs(cli): Add a paragraph about standard input
...
See commit 05dfcbc
6 years ago
a56a1015f0
style(docs): Fix RST lint errors reported by doc8
6 years ago
66adaee66c
docs: Add documentation on the new -f colored option
6 years ago
203cfc20f0
docs: Remove sudo from pip installation instructions
7 years ago
51c30505b5
docs: Add Mac OS installation instructions
...
See https://github.com/adrienverge/yamllint/issues/91 and
https://github.com/Homebrew/homebrew-core/blob/af2bbe9/Formula/yamllint.rb
7 years ago
ff9ebde608
docs: Remove old Debian / Ubuntu installation instructions
7 years ago
2b7f5c5e72
docs(install): Update Debian version
...
yamllint is now backported in Debian 8 (Jessie):
https://tracker.debian.org/pkg/yamllint
https://packages.debian.org/source/jessie-backports/yamllint
8 years ago
a483524b63
Doc: Update installing section
...
Packages are now also available in Debian and Ubuntu.
9 years ago
41733fc7a5
Use '.yaml' extension as default, not '.yml'
...
As someone said [1] on the internet:
Say ".yaml" not ".yml".
This is not MS-DOS, and YML is a Yahoo XML dialect.
Similarly, we use '.json', not '.jsn'.
[1]: https://github.com/ceph/s3-tests/commit/e17c56a
9 years ago
688858e639
Doc: Reference Fedora and Ubuntu packages
9 years ago
3f4f13e848
Doc: Update screenshot to include 'key-duplicates'
9 years ago
fee72d484e
Doc: Add a screenshot
9 years ago
38234a1d3c
Doc: Generate documentation with Sphinx
...
HTML documentation should be built with sphinx. This enables easy
integration with Read The Docs [1]. It can also be generated manually by
running:
make -C docs html
A man page can be generated by running:
make -C docs man
[1]: http://yamllint.readthedocs.org/
9 years ago
Adrien Vergé
Andrew Imeson
Remi Pointel