1
18%
develop: 91%

Ran 01 Dec 2013 11:18PM UTC

Files 25

Run time –

Badge

Embed ▾

Committed 01 Dec 2013 11:18PM UTC coverage: 18.255%. Remained the same

Job # 70.1

Build Type

push

travis-ci

Committed by Isis Lovecruft

Commit Message

Remove the TODO header in doc builds for index.rst.

The sphinx.ext.todo seem not to be working…

It is supposed to work, I believe, by putting the following into a
docstring:

    class Foo(object):
        """A foo.

        .. todo:: Do something about bar.
        """

And then the `.. todolist::` directive in Sphinx will find all such
`.. todo::` directives in your code, and put them in a list (the way I
was doing it, these would be on the index.html page) with links to where
the `.. todo::` is in the source code.

However, this seems to *only* work in docstrings proper in Python, the
following do *not* get picked up by the `.. todolist::` Sphinx
directive:

    * Normal Python inline comments, i.e.:
        # .. todo:: There is this thing we should do.

    * Sphinx attribute inline comments, i.e.:
        #: .. todo:: There is also another thing we should do.

Because all of the TODOs in BridgeDB are currently within normal Python
inline comments, the `.. todolist::` on the index page doesn't include
anything, and thus there is an awkward looking, giant, blank header with
nothing underneath it. Thus, I'm taking out the header, but leaving in
the `.. todolist::` directive (so that we *can* use `.. todo::` in a
proper docstring in the future and it will be automatically included in
the documentation here).

Run Details

613 of 3358 relevant lines covered (18.25%)

0.18 hits per line

isislovecruft / bridgedb / 70 / 1
18%
develop: 91%

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Source Files on job 70.1

isislovecruft / bridgedb / 70 / 1 18% develop: 91%

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Source Files on job 70.1

isislovecruft / bridgedb / 70 / 1
18%
develop: 91%

README BADGES
x