Include links to getting-started and style guide resources in documentation
Opened this issue · 0 comments
jeffreyliu commented
Use this thread to put together links and resources that would be helpful to have in the documentation
Using Github: https://guides.github.com/activities/hello-world/
PEP8 Python style guide: https://www.python.org/dev/peps/pep-0008/
Python linters:
- command line: https://pypi.python.org/pypi/pep8
- online: http://pep8online.com/
- sublime text: https://github.com/SublimeLinter/SublimeLinter-pep8
- atom: https://github.com/AtomLinter/linter-pycodestyle
- vim: https://github.com/nvie/vim-flake8
Python docstring format (Google-style):
http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
sublime text autodocstring: https://packagecontrol.io/packages/AutoDocstring