This will have already been handled by setuptools. If the user isn't
using this then they've dug their own grave.
Signed-off-by: Stephen Finucane <stephen@that.guru>
Start installing Python dependencies and Sphinx itself as part of the
CircleCI job rather than expecting it to be done in the Docker
container. This ensures we will use the version of the packages for a
given commit.
This is the other half of sphinx-doc/docker-ci#1.
Signed-off-by: Stephen Finucane <stephen@that.guru>
Add docs for '--module-first' option and 'SPHINX_APIDOC_OPTIONS'
environment variable. Per the closest thing we have to official man page
guidelines [1]:
ENVIRONMENT
lists all environment variables that affect the program or function
and how they affect it.
[1] https://linux.die.net/man/7/man-pages
Signed-off-by: Stephen Finucane <stephen@that.guru>
Fixes#2250
This appears to have been missed in commit 69d1dfaa. One could add an
alias for this to restore behavior, but no one has reported the issue
since Sphinx meaning this seems unnecessary.
Signed-off-by: Stephen Finucane <stephen@that.guru>
Run 'coverage report' after a successful coverage run. There's enough
coverage-related stuff here at this point to warrant its own section.
Signed-off-by: Stephen Finucane <stephen@that.guru>
This necessitates adding some basic coverage-py configuration [1] and
making sure the pytest-cov plugin uses said configuration [2]. Badges
are included.
Note that we do not run the 'coverage' tox target, which is reserved for
users.
[1] https://github.com/codecov/example-python
[2] https://bitbucket.org/ned/coveragepy/issues/512/
Signed-off-by: Stephen Finucane <stephen@that.guru>
Memo: for Japanese documents, jreport.cls already does that, so this
commit changes nothing. However as the class uses ``\chapter``, this
means that by default howto documents table of contents in PDF have
three levels, whereas manual documents only have two.
Notes:
- also fixes#4314
- although numbering of figures, tables and code-blocks will be same as
in html, due to issue #4318 the numbering of enclosing sectioning units
themselves may go deeper in html than PDF via latex. But this commit
makes sure numbering goes to minimal depth needed by numfig_secnum_depth
