PulpQE / pulp-smash / 465 / 4
63%
master: 63%

DEFAULT BRANCH: master
Ran
Files 6
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
coverage: 74.641%. Remained the same
465.4

push

travis-ci

Ichimonji10 
Make API docs show on Read The Docs

How is the API documentation built? The ``docs/api.rst`` file contains a
static index of documents in the ``docs/api/`` directory, and the
contents of the directory are automatically generated whenever a
relevant make target from ``docs/Makefile`` (such as "html") is
executed.

This works well so long as documentation is generated via one of the
make files. However, Read The Docs (RTD) does not use the make files.
Instead, it generates documentation by cd-ing into the ``docs``
directory and executing a command like this: [1]

    sphinx-build -b html . _build/html

What we really want is a system where:

* All users have access to the API documentation, including RTD.
* The API documentation stubs in ``docs/api/`` are auto-generated.
* An error or warning is shown if either ``docs/api.rst`` or the
  contents of ``docs/api/`` are incorrect.

Update the documentation build system to achieve these goals. Place the
documentation stubs in ``docs/api/`` under version control so RTD and
others can generate API documentation without without the make files.
And make the documentation-related make targets clean and regenerate the
contents of the ``docs/api/`` directory, thus accomplishing the other
two goals.

Fix https://github.com/PulpQE/pulp-smash/issues/204.

[1] https://read-the-docs.readthedocs.org/en/latest/builds.html

312 of 418 relevant lines covered (74.64%)

0.75 hits per line

Source Files on job 465.4