Feature/v2 (#69)

* Add v2 first commit

* Add tests

* Fix travis settings

* Fix refer to 1.0.0

* Fix python settings

* Fix report

* Fix tests path

* Fix remove cd command

* Update .gitignore

Author: heavenshell

.gitignore

@@ -1,5 +1,183 @@
-.swp
+### https://raw.github.com/github/gitignore/85bf08b19a77c62d7b6286c2db8811f2ff373b0f/Global/Vim.gitignore
+
+# Swap
+[._]*.s[a-v][a-z]
+!*.svg  # comment out if you don't need vector files
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+
+# Session
+Session.vim
+Sessionx.vim
+
+# Temporary
+.netrwhist
 *~
-.DS_Store
+# Auto-generated tag files
 tags
+# Persistent undo
+[._]*.un~
+
+
+### https://raw.github.com/github/gitignore/85bf08b19a77c62d7b6286c2db8811f2ff373b0f/Python.gitignore
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+
+### https://raw.github.com/github/gitignore/85bf08b19a77c62d7b6286c2db8811f2ff373b0f/Global/macOS.gitignore
+
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# App
+doq
 vader.vim/

.travis.yml

@@ -1,10 +1,9 @@
-sudo: false
-dist: trusty
+dist: bionic
 language: vim
 
 install:
   - pwd
-  - git clone https://github.com/junegunn/vader.vim.git test/vader.vim
+  - git clone https://github.com/junegunn/vader.vim.git tests/vader.vim
   - git clone https://github.com/vim/vim /tmp/vim
   - mkdir ~/tmp
   - cd /tmp/vim
@@ -13,12 +12,15 @@ install:
   - make && make install
   - git clone https://github.com/junegunn/vader.vim.git
   - export VIM_EXE=$HOME/tmp/vim/bin/vim
+  - sudo apt-get install python3
+  - sudo apt-get install python3-dev
+  - sudo apt-get install python3-venv
   - cd $HOME/build/heavenshell/vim-pydocstring
+  - make install
 
 before_script:
   - $HOME/tmp/vim/bin/vim --version
 
 script:
-  - cd test
-  - ./run.sh > /dev/null && echo Success || echo Fail
-  - cd ..
+  - cd tests
+  - ./run.sh

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2011, Shinya Ohyanagi.
+Copyright (c) 2010-2020, Shinya Ohyanagi.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

Makefile

@@ -0,0 +1,7 @@
+.PHONY: install
+install:
+	bash lib/install.sh
+
+.PHONY: clean
+clean:
+	rm -rf lib/doq lib/venv

README.rst

@@ -10,17 +10,48 @@ Pydocstring is a generator for Python docstrings and is capable of automatically
 
 * inserting one-line docstrings
 * inserting multi-line docstrings
-* inserting comments
 
 This plugin is heavily inspired by `phpdoc.vim <http://www.vim.org/scripts/script.php?script_id=1355>`_ and `sonictemplate.vim <https://github.com/mattn/sonictemplate-vim>`_.
 
-Usage
------
+Install
+-------
+
+Since version 2, pydocstring requires `doq <https://pypi.org/project/doq/>`_.
+
+You can install following command.
+
+.. code::
+
+  $ make install
+
+If you want install doq manually, you can install from PyPi.
+
+.. code::
+
+  $ python3 -m venv ./venv
+  $ ./venv/bin/pip3 install doq
+
+Than set installed `doq <https://pypi.org/project/doq/>`_. path to `g:pydocstring_doq_path`.
+
+
+Note
+~~~~
+
+pydocstring is now support only Vim8.
+If you want use old version checkout `1.0.0 <https://github.com/heavenshell/vim-pydocstring/releases/tag/1.0.0>`_
+
+Basic usage
+-----------
 
 1. Move your cursor on a `def` or `class` keyword line,
-2. type `:Pydocstring` or enter `<C-l>` (default keymapping) and
+2. type `:Pydocstring` and
 3. watch a docstring template magically appear below the current line
 
+Format all
+----------
+
+type `:PydocstringFormat` will insert all docstrings to current buffer.
+
 Settings
 --------
 Pydocstring depends on ``softtabstop``.
@@ -40,3 +71,12 @@ If you want change default keymapping, set following to your `.vimrc`.
 .. code::
 
   nmap <silent> <C-_> <Plug>(pydocstring)
+
+Custom template
+---------------
+
+You can set custom template
+
+.. code::
+
+  let g:pydocstring_template_path = '/path/to/custom/templates'