Kintyre / ksconf / 267
90%

DEFAULT BRANCH: master
Ran
Jobs 8
Files 45
Run time 2min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
267

push

travis-ci

lowell80 
Docs 2.0 - Refactor ALL the docs (PR #40)

-------------------------------------------------------------------------------

Summary:

* Moving away from the CLI "--help" output is the docs mentality.  That just
  too hard to maintain, makes formatting very difficult, and reduces usability.
* Switched to ReStructuredText for all internal docs for much greater
  versatility.  That's now used for (1) core docs, (2) in-line code docs, and
 (3) sparingly used in the CLI help & description strings.
* Using an "argparse" addon library to generate the embedded form of
  command-oriented documentation.
* Split docs into 2 main sections:  User manual and reference material.
* Split the install guide into 2 sections.  Advanced stuff should be less
  necessary with the Splunk app install option available to us.
* Tweaked some internal stuff like "--version" output.
* Added several more pages of completely fresh content

-------------------------------------------------------------------------------

Squashed commit of the following:

commit dfb266bc6
Author: Lowell Alleman <lowell@kintyre.co>
Date:   Sat Feb 9 00:04:25 2019 -0500

    Change ReStructuredText indentation :-(

    Big blind commit.  It ALL changed.  Should pay off long term.

    Updated help non-manual formatters to use a custom (ReST-stripping) new custom
    formatter too.

    Did some minor working changes, spelling, and so on...

commit 347f40e4c
Author: Lowell Alleman <lowell@kintyre.co>
Date:   Fri Feb 8 22:08:11 2019 -0500

    AppVeyor build fix

    Not sure why 'six' is all of a sudden needed *before* setup.py completes,
    but whatever.   It's probably automatically installed in Travis.

commit d47a8c3b8
Author: Lowell Alleman <lowell@kintyre.co>
Date:   Fri Feb 8 21:21:16 2019 -0500

    Consolidating doc tools and cleaning up '--version' output

    - Consolidated ksconf_subcommands.csv tabl... (continued)

3118 of 3292 relevant lines covered (94.71%)

7.51 hits per line

Jobs
ID Job ID Ran Files Coverage
1 267.1 0
94.66
 Travis Job 267.1
2 267.2 0
93.5
 Travis Job 267.2
3 267.3 (EXTRA_PKGS="argcomplete") 0
93.38
 Travis Job 267.3
4 267.4 (BUILD_SDIST=true) 0
93.5
 Travis Job 267.4
5 267.5 0
93.5
 Travis Job 267.5
6 267.6 (PYENV_VERSION=2.7.15) 0
94.66
 Travis Job 267.6
7 267.7 (PYENV_VERSION=3.6.5) 0
93.5
 Travis Job 267.7
8 267.8 0
94.6
 Travis Job 267.8
Source Files on build 267
Detailed source file information is not available for this build.