cloudmarker / cloudmarker
100%
master: 84%

LAST BUILD BRANCH: dependabot/pip/urllib3-1.26.5
DEFAULT BRANCH: master
Repo Added
Files 92
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

LAST BUILD ON BRANCH sphinx
branch: sphinx
CHANGE BRANCH
x

98

Pull #6

travis-ci-com

web-flow 
Generate API documentation

This change generates automatic API documentation from the docstrings in
the project package. Here is a list of changes done:

  - The `docs` target in `Makefile` has been updated with a
    `sphinx-apidoc` command that automatically reads the Python source
    files and generates the Sphinx source files necessary to create API
    documentation.

  - The docstrings in the Python source code have been improved to look
    good in the generated documentation.

  - Example Python interactive sessions (also known as doctest format
    examples) have been added wherever applicable. These doctest format
    examples are recognized by Sphinx documentation generator and
    rendered appropriately in the generated documentation.

  - Since we now have doctest format examples the `test` target in
    `Makefile` has been updated to run Python's `doctest` utility to
    test these examples.

  - A `__init__.py` file has been added for every subpackage. This
    allows us to write package level docstrings. It also helps
    `sphinx-apidoc` to discover all subpackages without having to use
    its `--implicit-namespaces` option.

    We don't have a need for splitting our project package across
    multiple independent directories at this time, so we don't need
    implicit namespaces right now.
Pull Request #6: Create a Sphinx project for documentation

57 of 57 branches covered (100.0%)

Branch coverage included in aggregate %.

4 of 4 new or added lines in 3 files covered. (100.0%)

303 of 303 relevant lines covered (100.0%)

3.0 hits per line

Relevant lines Covered
303 RELEVANT LINES 303 COVERED LINES
3.0 HITS PER LINE
Source Files on sphinx
Coverage ∆ File Lines Relevant Covered Missed Hits/Line Branch Hits Branch Misses

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
98 sphinx Generate API documentation This change generates automatic API documentation from the docstrings in the project package. Here is a list of changes done: - The `docs` target in `Makefile` has been updated with a `sphinx-apidoc` command that... Pull #6 web-flow travis-ci-com pending completion  
97 sphinx Generate API documentation This change generates automatic API documentation from the docstrings in the project package. Here is a list of changes done: - The `docs` target in `Makefile` has been updated with a `sphinx-apidoc` command that... push susam travis-ci-com pending completion  
95 sphinx Generate API documentation This change generates automatic API documentation from the docstrings in the project package. Here is a list of changes done: - The `docs` target in `Makefile` has been updated with a `sphinx-apidoc` command that... Pull #6 web-flow travis-ci-com pending completion  
94 sphinx Generate API documentation This change generates automatic API documentation from the docstrings in the project package. Here is a list of changes done: - The `docs` target in `Makefile` has been updated with a `sphinx-apidoc` command that... push susam travis-ci-com pending completion  
81 sphinx Generate API documentation This change generates automatic API documentation from the docstrings in the project package. Here is a list of changes done: - The `docs` target in `Makefile` has been updated with a `sphinx-apidoc` command that... Pull #6 web-flow travis-ci-com pending completion  
80 sphinx Generate API documentation This change generates automatic API documentation from the docstrings in the project package. Here is a list of changes done: - The `docs` target in `Makefile` has been updated with a `sphinx-apidoc` command that... push susam travis-ci-com pending completion  
74 sphinx Generate API documentation This change generates automatic API documentation from the docstrings in the project package. Here is a list of changes done: - The `docs` target in `Makefile` has been updated with a `sphinx-apidoc` command that... Pull #6 web-flow travis-ci-com pending completion  
73 sphinx Generate API documentation This change generates automatic API documentation from the docstrings in the project package. Here is a list of changes done: - The `docs` target in `Makefile` has been updated with a `sphinx-apidoc` command that... push susam travis-ci-com pending completion  
67 sphinx Generate API documentation This change generates automatic API documentation from the docstrings in the project package. Here is a list of changes done: - The `docs` target in `Makefile` has been updated with a `sphinx-apidoc` command that... Pull #6 web-flow travis-ci-com pending completion  
66 sphinx Generate API documentation This change generates automatic API documentation from the docstrings in the project package. Here is a list of changes done: - The `docs` target in `Makefile` has been updated with a `sphinx-apidoc` command that... push susam travis-ci-com pending completion  
See All Builds (953)