Commit Graph

9614 Commits

Author SHA1 Message Date
Takeshi KOMIYA
9ddb51ea2f
Merge pull request #4352 from jakobandersen/io_parallel
Fix missing metainfo for sphinx.io
2017-12-30 00:34:55 +09:00
Takeshi KOMIYA
0998bd5330
Merge pull request #4355 from stephenfin/remove-epub3-references
templates: Remove 'epub3' targets
2017-12-29 10:30:55 +09:00
Takeshi KOMIYA
8c542e1222
Merge pull request #4356 from stephenfin/bug/2250
doc: Add missing sphinx-apidocs opt, envvar
2017-12-29 10:02:43 +09:00
Stephen Finucane
9f7f5f2a44 doc: Add missing sphinx-apidocs opt, envvar
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
2017-12-28 23:00:53 +00:00
Stephen Finucane
35ad6910a9 epub: Remove dead templates
These are no longer used since 'f2c93b31'.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-28 21:37:37 +00:00
Stephen Finucane
f048d668e5 doc: Remove invalid note for epub3 builder
This doesn't appear to be true any more, based on the code.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-28 21:28:55 +00:00
Stephen Finucane
f4f677c8f7 templates: Remove 'epub3' targets
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>
2017-12-28 21:18:23 +00:00
Jakob Lykke Andersen
e5ba527dd5 Fix missing metainfo for sphinx.io 2017-12-28 17:16:53 +01:00
Jakob Lykke Andersen
217c5f3856 Fixes for previous commit 2017-12-28 17:04:21 +01:00
Jakob Lykke Andersen
f3c05adebc C++, fix handling of (templated) operators 2017-12-28 16:50:32 +01:00
Takeshi KOMIYA
324bc7e3c4
Merge pull request #4349 from tk0miya/build_own_docs_as_a_test
travis: Build own docs as a test
2017-12-28 23:23:03 +09:00
Takeshi KOMIYA
0cc6cdd7cc travis: Build own docs as a test 2017-12-28 10:48:29 +09:00
Takeshi KOMIYA
42947beabd
Merge pull request #4346 from tk0miya/4344_update_docs
docs: make explicitly :meth: reference (refs: #4344)
2017-12-28 10:42:58 +09:00
Takeshi KOMIYA
626e8980cd
Merge pull request #4337 from stephenfin/the-great-toxification
The great toxification (part 6)
2017-12-27 15:29:16 +09:00
Takeshi KOMIYA
b094c401de docs: make explicitly :meth: reference (refs: #4344) 2017-12-27 14:59:59 +09:00
Jakob Lykke Andersen
25d18e6517 Merge branch 'master' of github.com:sphinx-doc/sphinx 2017-12-25 11:27:05 +01:00
Takeshi KOMIYA
e1a543f6ad
Merge pull request #4341 from stephenfin/bug/4339
tox: Add 'PERL5LIB' to 'passenv' list
2017-12-25 13:31:31 +09:00
Stephen Finucane
f068627176 gitignore: Ignore 'htmlcov' directory
This is generated if you run 'coverage html'. Hide it from Git.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-24 21:24:41 +00:00
Stephen Finucane
77ca894723 tox: Report coverage to user
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>
2017-12-24 21:24:41 +00:00
Stephen Finucane
a3f9935d95 travis: Enable codecov coverage
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>
2017-12-24 21:24:41 +00:00
Jakob Lykke Andersen
9766c2f339 C++, support the template disambiguator for dependent names. 2017-12-24 16:31:10 +01:00
Stephen Finucane
411055905c tox: Add 'PERL5LIB' to 'passenv' list
This is required by 'makeinfo'.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Fixes #4339
2017-12-24 14:47:31 +00:00
Takeshi KOMIYA
a9efb2517a Fix flake8 violations 2017-12-23 21:21:21 +09:00
jfbu
2e04c2a058 Update CHANGES for PR #4332 2017-12-21 19:33:47 +01:00
Jean-François B
f5dfdfcfe2
Merge pull request #4332 from jfbu/latex_math_numfig
Let LaTeX obey :confval:`math_numfig` for equation numbering
2017-12-21 19:32:10 +01:00
jfbu
8cbd66f822 Trim docs about math_numfig 2017-12-21 18:47:35 +01:00
jfbu
5ca9d0578b Update CHANGES for PR #4331 2017-12-21 18:37:45 +01:00
Jean-François B
cd75337780
Merge pull request #4331 from jfbu/4330_latex_howto_tocdepth
Set LaTeX default tocdepth to 2 for howto documents (fixes #4330)
2017-12-21 18:34:54 +01:00
Takeshi KOMIYA
e2e907b3ee Fix broken test_autodoc 2017-12-22 00:53:53 +09:00
Takeshi KOMIYA
6f1818bb7e
Merge pull request #4328 from KevKeating/ignore__all__
Fix #947: Adding autodoc option to ignore a module's __all__
2017-12-22 00:29:23 +09:00
Takeshi KOMIYA
ce39643fcc
Merge branch 'master' into ignore__all__ 2017-12-22 00:29:14 +09:00
Takeshi KOMIYA
ffa9d48d0e
Merge branch 'master' into ignore__all__ 2017-12-22 00:28:26 +09:00
Takeshi KOMIYA
389b6d2ec1
Merge pull request #4324 from tk0miya/refactor_test_autodoc2
test_autodoc: Separate testdata (python objects) and testcases
2017-12-22 00:25:44 +09:00
jfbu
7ec3a23762 Avoid using bare except 2017-12-21 12:43:53 +01:00
jfbu
3bb61e9094 Let LaTeX obey :confval:math_numfig for equation numbering 2017-12-21 12:23:20 +01:00
jfbu
201c59126f Set LaTeX default tocdepth to 2 for howto documents (fixes #4330)
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.
2017-12-21 09:31:31 +01:00
Takeshi KOMIYA
ec240614d9 test_autodoc: Separate testdata (python objects) and testcases 2017-12-21 12:12:13 +09:00
jfbu
24c9103a2c Update CHANGES 2017-12-21 00:19:23 +01:00
jfbu
c7a4283ff7 Update CHANGES for PR #4311 2017-12-21 00:04:40 +01:00
jfbu
91350f35fa Remove hard-coded numbers to let LATEXSECTIONNAMES become patchable 2017-12-20 23:55:56 +01:00
jfbu
43bed034cd Add test for latex obey numfig_secnum_depth feature 2017-12-20 23:28:24 +01:00
jfbu
7ea4fa535a Make LaTeX obey numfig_secnum_depth for figures, tables, code-blocks
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
2017-12-20 23:27:39 +01:00
jfbu
ff7e44a511 Merge branch 'stable' 2017-12-20 23:23:31 +01:00
jfbu
8c72f98c78 Update CHANGES for PR #4316 2017-12-20 22:45:22 +01:00
jfbu
dab7b49cd9 Correct merge error in writers/latex.py 2017-12-20 22:19:35 +01:00
jfbu
0a66d51cbc Merge branch 'stable' 2017-12-20 21:52:45 +01:00
Jean-François B
fa20b7af5c
Merge pull request #4316 from jfbu/4315_toplevel_sectioning
4315 toplevel sectioning
2017-12-20 21:46:03 +01:00
jfbu
1ee2c2fb95 Re-use some existing test with extras 2017-12-20 21:30:05 +01:00
Kevin Keating
e932ff5ad2 Closes #947: autodoc now supports ignore-module-all to ignore a module's __all__ 2017-12-20 15:07:33 -05:00
Takeshi KOMIYA
a95bc095c0
Merge pull request #4305 from tk0miya/refactor_registry
Refactor registry
2017-12-21 01:37:29 +09:00