Welcome to docformatter!
¶
Contents:
How to Install docformatter
Install from PyPI
Install from GitHub
How to Use docformatter
Use from the Command Line
Use as a PyCharm File Watcher
Use with pre-commit
Use with GitHub Actions
How to Configure docformatter
A Note on Options to Control Styles
A Note on reST Header Adornments Regex
Miscellaneous:
docformatter Requirements
PEP 257 Requirements
Docstring Style
Program Control
Test Suite
Current Implementation
Arguments Needed for Future Releases
Issue and Version Management
Known Issues and Idiosyncrasies
Wrapping Descriptions
Authors
Author
Additional contributions by (sorted by name)
License
Indices and tables
¶
Index
Module Index
Search Page
docformatter
Navigation
Contents:
How to Install docformatter
How to Use docformatter
How to Configure docformatter
Miscellaneous:
docformatter Requirements
Known Issues and Idiosyncrasies
Authors
License
Related Topics
Documentation overview
Next:
How to Install docformatter
Quick search