Dog food this feature. Validated with the following (broken) change:
--- a/doc/contents.rst
+++ b/doc/contents.rst
@@ -18,6 +18,9 @@ Sphinx documentation contents
intl
theming
setuptools
+
+ .. This is broken!!!
+
templating
latex
markdown
Signed-off-by: Stephen Finucane <stephen@that.guru>
This is easier than creating a virtualenv, installing deps and running
make. It also makes explicit use of the setuptool integration that is
now documented.
Signed-off-by: Stephen Finucane <stephen@that.guru>
While this feature is somewhat documented in the API guide, there's
nothing about this option in the main user guide. Given the lack of
blogs and articles talking about this feature, along with the amount of
projects that are only using the same copy-paste '[build_sphinx]'
definition, I imagine this is an issue.
Make the feature a little more accessible by adding a section to the
main user guide that details (a) the fact the feature exists, (b) why
you'd want to use it, and (c) how you can use it.
Signed-off-by: Stephen Finucane <stephen@that.guru>
(macro is needed by ``\sphinxdepreactionwarning`` which may in future
be used at location of the various ``\RequirePackage``, definition of
``\spx@ifundefined`` was too far down)
Memo 1: footnotes from captions are inserted by this commit via
table templates, so it is easy to put caption at foot of table
rather than at head, if wanted.
Memo 2: footnotes from table header need restriction due to
longtable only. But one can not tell in advance if table will be
rendered by longtable or not, hence one must restrict always.
Memo: footnotehyper-sphinx LaTeX package incorporates here some fixes
from upstream footnotehyper 0.99. At Sphinx 1.6 il will for simplicity
copy all of upstream footnotehyper 0.99. Then old footnote.sty LaTeX
package is not a dependency of Sphinx anymore.
