Style-Doc is Black for Python docstrings and reStructuredText (rst). It can be used to format docstrings (Google docstring format) in Python files or reStructuredText.
Style-Doc can handle Linux, Windows and Mac style line endings. The output will nevertheless be convertet to \n Linux line endings.
- Maintainers
- Installation
- Usage
- Examples
- Support and Feedback
- Reporting Security Vulnerabilities
- Contribution
- Code of Conduct
- Licensing
This project is maintained by the One Conversation
team of Deutsche Telekom AG.
It is based on the
style_doc.py
script from the HuggingFace team.
Many thanks for your consent
to publish it as a standalone package 🤗 ♥.
Style-Doc is available at the Python Package Index (PyPI). It can be installed with pip:
$ pip install style-doc$ style-doc --help
usage: style-doc [-h] [--max_len MAX_LEN] [--check_only] [--py_only]
[--rst_only]
files [files ...]
positional arguments:
files file(s) or folder(s) to restyle
optional arguments:
-h, --help show this help message and exit
--max_len MAX_LEN maximum length of lines, default: 119
--check_only only check and not fix styling issues
--py_only only check py files
--rst_only only check rst files- format all docstrings (.py files) and rst files in the
srcanddocsfolder with line length of 99:
style-doc --max_len 99 src docs - check all docstrings (.py files) and rst files in the
srcanddocsfolder with line length of 99:
style-doc --max_len 99 --check_only src docs - format all docstrings (.py files only) in the
srcfolder with line length of 99:
style-doc --max_len 99 --py_only src - check all docstrings (.py files only) in the
srcfolder with line length of 99:
style-doc --max_len 99 --check_only --py_only src - format all rst files only in the
docsfolder with line length of 99:
style-doc --max_len 99 --rst_only docs - check all rst files only in the
docsfolder with line length of 99:
style-doc --max_len 99 --check_only --rst_only docs
To integrate Style-Doc (and more checks) into your GitHub Actions see our static_checks.yml example and our configuration in setup.py.
The following channels are available for discussions, feedback, and support requests:
This project is built with security and data privacy in mind to ensure your data is safe. We are grateful for security researchers and users reporting a vulnerability to us, first. To ensure that your request is handled in a timely manner and non-disclosure of vulnerabilities can be assured, please follow the below guideline.
Please do not report security vulnerabilities directly on GitHub. GitHub Issues can be publicly seen and therefore would result in a direct disclosure.
Please address questions about data privacy, security concepts, and other media requests to the [email protected] mailbox.
Our commitment to open source means that we are enabling - in fact encouraging - all interested parties to contribute and become part of our developer community.
Contribution and feedback is encouraged and always welcome. For more information about how to contribute, as well as additional contribution information, see our Contribution Guidelines.
This project has adopted the Contributor Covenant as our code of conduct. Please see the details in our Contributor Covenant Code of Conduct. All contributors must abide by the code of conduct.
Copyright (c) 2020 The HuggingFace Inc. team
Copyright (c) 2021 Philip May, Deutsche Telekom AG
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.