Sphinx Documentation Release 1.5.6
Total Page:16
File Type:pdf, Size:1020Kb
Load more
Recommended publications
-
Coala Documentation Release 0.4.1.Dev0
coala Documentation Release 0.4.1.dev0 The coala Developers February 16, 2016 Home i ii CHAPTER 1 coala Installation This document contains information on how to install coala. Supported platforms are Linux and Windows. coala is known to work on OS X as well. coala is tested against CPython 3.3, 3.4 and 3.5. In order to run coala you need to install Python. It is recommended, that you install Python3 >= 3.3 from http://www.python.org. The easiest way to install coala is using pip (Pip Installs Packages). If you don’t already have pip, you can install it like described on https://pip.pypa.io/en/stable/installing.html. Note that pip is shipped with recent python versions by default. 1.1 System wide installation The simplest way to install coa ais to do it system-wide. But, This is generally discouraged in favor or using a virtualenv. To install the latest most stable version of coala system-wide, use: $ pip3 install coala To install the nightly build from our master branch, you can do: Note: For this and all future steps, some steps require root access (also known as administrative privileges in Win- dows). Unix based (Max, Linux) - This can be achieved by using sudo in front of the command sudo command_name instead of command_name Windows - The easiest way on windows is to start a command prompt as an administrator and start setup.py. $ pip3 install coala --pre 1.2 Installing inside a virtualenv Virtualenv is probably what you want to use during development, you’ll probably want to use it there, too. -
Coala Documentation Release 0.7.0
coala Documentation Release 0.7.0 The coala Developers June 22, 2016 Home 1 coala Installation 1 1.1 System wide installation.........................................1 1.2 Installing inside a virtualenv.......................................2 1.3 Installing coala from source.......................................2 1.4 Dependencies...............................................3 2 coala Tutorial 5 2.1 Prerequisites...............................................5 2.2 Get Some Code..............................................5 2.3 Let’s Start!................................................5 2.4 Sections..................................................6 2.5 Auto-applying results..........................................7 2.6 Setting Inheritance............................................8 2.7 Ignoring Issues..............................................8 2.8 Enabling/Disabling Sections.......................................9 2.9 Show bears’ information.........................................9 2.10 Continuing the Journey.......................................... 10 3 The .coafile Specification 11 3.1 Naming, Scope and Location...................................... 11 3.2 Setting Inheritance............................................ 11 4 Glob - Extended unix style pathname expansion 13 4.1 Syntax.................................................. 13 4.2 Examples................................................. 13 5 Exit Codes 17 6 External APIs 19 6.1 DBus................................................... 19 7 Git Hooks 21 7.1 Pre Commit -