Coala Documentation Release 0.4.1.Dev0
Total Page:16
File Type:pdf, Size:1020Kb
Load more
Recommended publications
-
Sphinx Documentation Release 1.5.6
Sphinx Documentation Release 1.5.6 Georg Brandl Nov 13, 2017 Contents 1 Introduction 1 1.1 Conversion from other systems....................................1 1.2 Use with other systems........................................2 1.3 Prerequisites..............................................2 1.4 Usage..................................................2 2 First Steps with Sphinx 3 2.1 Install Sphinx..............................................3 2.2 Setting up the documentation sources................................3 2.3 Defining document structure.....................................4 2.4 Adding content.............................................5 2.5 Running the build...........................................5 2.6 Documenting objects..........................................5 2.7 Basic configuration...........................................6 2.8 Autodoc.................................................7 2.9 Intersphinx...............................................7 2.10 More topics to be covered.......................................8 3 Man Pages 9 3.1 Core Applications...........................................9 3.2 Additional Applications........................................ 15 4 reStructuredText Primer 19 4.1 Paragraphs............................................... 19 4.2 Inline markup.............................................. 19 4.3 Lists and Quote-like blocks...................................... 20 4.4 Source Code............................................... 21 4.5 Tables................................................. -
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 -