Commit Graph

9642 Commits

Author SHA1 Message Date
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
Takeshi KOMIYA
e2bf2ef11d
Merge pull request #4166 from jahn/math_numfig
Number equations across pages and by section (fix #3991, #4080)
2017-12-21 00:39:44 +09:00
Takeshi KOMIYA
b07de53061 Fix mypy violation 2017-12-21 00:19:02 +09:00
Takeshi KOMIYA
90159b8143 Merge branch 'master' into refactor_registry 2017-12-21 00:16:32 +09:00
Jakob Lykke Andersen
42f557d4b0 Merge branch 'master' of github.com:sphinx-doc/sphinx 2017-12-20 09:06:22 +01:00
Jakob Lykke Andersen
c7a145cc18 C++, handle defaulted constrained template type parameters 2017-12-20 09:05:34 +01:00
Takeshi KOMIYA
26ed80d7d7
Merge pull request #4322 from stephenfin/the-great-toxification
The great toxification
2017-12-20 14:47:02 +09:00
Takeshi KOMIYA
771e122980
Merge pull request #4329 from pvcraven/patch-1
Add "Arcade" library documentation to examples
2017-12-20 14:32:58 +09:00
Paul V Craven
3fe218e759
Update arcade.academy link
Update http://arcade.academy link to use http instead of https.
2017-12-19 21:14:36 -06:00
Takeshi KOMIYA
f04260dc9c
Merge pull request #4323 from tk0miya/update_docs
doc: Remove mentions to deprecated options (both are removed at 1.3)
2017-12-20 10:45:53 +09:00
Takeshi KOMIYA
7054c0306a doc: Remove mentions to deprecated options (both are removed at 8c2fabe v1.3) 2017-12-20 10:43:13 +09:00
Paul V Craven
221aa470fa
Add "Arcade" library documentation to examples 2017-12-19 17:28:28 -06:00
Takeshi KOMIYA
b103b3c24a doc: Use anonymous link target for README 2017-12-20 01:28:07 +09:00
Takeshi KOMIYA
516cbec2f9
Merge pull request #4326 from stephenfin/readme-improvements
README: Fix typo
2017-12-20 01:05:12 +09:00
Stephen Finucane
ac9ae4d54b README: Fix typo
Signed-off-by: Stephen Finucane <stephen@that.guru>
Fixes: 393f59d ("Improve README")
2017-12-19 16:02:05 +00:00
Stephen Finucane
a2a873d58a tox: Add documentation for all targets
This should make 'tox -av' more helpful.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-19 15:55:10 +00:00
Takeshi KOMIYA
b00f78311f
Merge pull request #4321 from stephenfin/readme-improvements
Readme improvements
2017-12-20 00:38:41 +09:00
Takeshi KOMIYA
838f7fc29a Add Domain.add_object_type() to update internal caches correctly 2017-12-20 00:31:43 +09:00
Takeshi KOMIYA
b4a1bddeaa
Merge pull request #4313 from tk0miya/update_math_doc
Fix doc: now eq role works whole of project
2017-12-20 00:26:53 +09:00
Stephen Finucane
638e646766 doc: Rework CONTRIBUTING to encourage use of tox
Embrace the tox-ified future. This explicitly asks users to use a
virtualenv to stop them shooting themselves in the foot.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-19 15:22:14 +00:00
Stephen Finucane
76bd631872 travis: Start using tox for testing
This allows us to validate and reuse the testing tools we use locally
for "gate" tests and moves us closer to the eventual goal of deprecating
the Makefile targets. This involves adding two new targets to the list
of default targets run by tox - docs and mypy.

Note that we don't use tox-travis because, wonderful though it may be,
configuring it to exclude as many of the tests as we want to exclude is
a little convoluted (we have a big test matrix).

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-19 15:21:42 +00:00
Stephen Finucane
a6f0ba0fc9 README: Cleanup badges
Add AppVeyor badge and include 'alt' attributes for the others.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-19 15:05:44 +00:00
Stephen Finucane
393f59da00 Improve README
We're going to be adding additional badges to this but, before we do
that, we should improve the README and remove a lot of the duplication
that has built up here.

The 'long_description' from 'setup.py' is moved into the README as there
is serious value in displaying this on GitHub, as much as there is value
in including the badges and other content from README.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-19 15:00:06 +00:00
Stephen Finucane
f74b6756ac setup.cfg: Restructure file
Place configuration of the package itself first in the file, followed by
configuration of other tools.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-19 12:06:16 +00:00
Takeshi KOMIYA
f98bc4becc
Merge pull request #4175 from stephenfin/the-great-toxification-5
The great toxification (part 5)
2017-12-19 15:21:24 +09:00
Stephen Finucane
fd1df0815b tox: Make further use of factor-conditional deps
This is how we reduce boilerplate [1]. Succinctness FTW.

[1] https://tox.readthedocs.io/en/latest/config.html#factors-and-factor-conditional-settings

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-18 20:10:18 +00:00