Commit Graph
1607 Commits
Author SHA1 Message Date
Brecht Machiels 405ef96d2a Find third-party builders by entry point
A builder is uniquely identified by its name, which can be used as an
entry point in the 'sphinx.builders' entry point group. This obviates
the need to register the builder as an extension.

The built-in builders are still loaded as before. New third-party builders
should provide an entry point in their setup.py:

    entry_points={
        'sphinx.builders': [
            'mybuilder = mypackage.mymodule:MyBuilder',
        ],
    }

Like before, builders should define a setup(app) function in the
'mypackage.module' module to define configuration variables etc. It is
no longer necessary to register the builder using Sphinx.add_builder().

Existing builders can still be loaded the traditional way, by including
their module name in the extensions list in conf.py.
2017-04-10 13:04:41 +02:00
Takeshi KOMIYA fc41f43a70 Merge branch 'stable' 2017-04-02 19:05:50 +09:00
Takeshi KOMIYA 592b808005 Merge pull request #3585 from eric-wieser/escape-autosummary
BUG: Fix autosummary of members with a trailing underscore
2017-03-29 22:56:32 +09:00
Eric Wieser 804891c4a1 BUG: Fix autosummary of members with a trailing underscore 2017-03-26 12:54:03 +01:00
Takeshi KOMIYA 3e46f52a96 Merge pull request #3475 from agjohnson/domain-js-add-nesting
Add nesting, package directive, and method directive to JavaScript domain
2017-03-26 18:16:04 +09:00
Takeshi KOMIYA 8f9dd64992 Merge branch 'stable' 2017-03-26 11:52:15 +09:00
Takeshi KOMIYA c57e47e042 Year++ 2017-03-26 11:49:34 +09:00
jfbu 254c04500b Merge branch 'stable' 2017-03-23 11:13:22 +01:00
jfbu 89431bf833 Fix accidental use of `language='ja'` in docs (at 41bb388) 2017-03-23 11:03:38 +01:00
Takeshi KOMIYA 6376e6053c Merge branch 'stable' 2017-03-22 09:49:48 +09:00
jfbu a0a0e6cab0 Fix typo 2017-03-21 09:23:35 +01:00
jfbu 68ac715565 Update domains.rst 2017-03-21 08:26:11 +01:00
jfbu 41bb38877f Update docs (domains.rst) 2017-03-21 08:24:35 +01:00
Christopher Chang 9af298dcfa Update domains.rst 2017-03-20 15:42:17 -07:00
Christopher Chang 3f2c3790ce fixed a grammatical mistake 2017-03-20 14:13:49 -07:00
Takeshi KOMIYA aa6dfb8b41 Merge branch 'stable' 2017-03-18 18:25:50 +09:00
jfbu 39bce2f90a Remove documentation of `\sphinxquotedblleft` from next minor release
Indeed, the macros will perhaps be removed already at 1.6, (PR #3562),
hence it is better not to document them at 1.5.4.
2017-03-16 23:01:12 +01:00
Anthony Johnson 3ba60ffd5d Add nesting, module directive, and method directive to JavaScript domain
* Adds nesting to the JavaScript domain, to allow for nesting of elements
* Adds the ``js:module`` directive, which behaves similarly to the Python
  directive
* Adds the ``js:method`` directive, an alias to ``js:function``
* Adds roles for ``js:mod`` and ``js:meth``
* Updates tests to passing cases
* Adds docs for new features
2017-03-15 22:27:48 -07:00
Rob Ruana b7efbfe615 Fix #3174: [Napoleon] Defers autodoc-skip-member to other extensions if Napoleon doesn't care if the member is skipped 2017-03-14 18:53:27 -07:00
jfbu bc0682af0e Merge branch 'stable'
Conflicts resolved:
	sphinx/domains/cpp.py
	sphinx/domains/python.py
	sphinx/texinputs/sphinx.sty
	sphinx/util/docfields.py
	sphinx/writers/latex.py
	tests/test_build_latex.py

Also updated:
    sphinx/domains/__init__.py
2017-03-12 13:01:47 +01:00
Takeshi KOMIYA db6e1db5cb doc: Add warning for only directive (refs: #3539) 2017-03-12 01:47:11 +09:00
Takeshi KOMIYA dbffb053c9 Merge pull request #3534 from tk0miya/add_post_transform
Add post transform
2017-03-11 09:28:57 +09:00
jfbu 19558c9800 Update latex builder docs (latexmk requirement) 2017-03-10 19:11:06 +01:00
Takeshi KOMIYA eb5577bb9c Update docs 2017-03-10 16:43:27 +09:00
jfbu 990f51d680 Update latex docs 2017-03-10 08:42:37 +01:00
Takeshi KOMIYA 99ded4c8b1 Add Sphinx.add_post_transform() 2017-03-10 10:49:08 +09:00
Yoshiki Shibukawa 7e178785a7 fix style check warnings 2017-03-03 22:03:16 +09:00
jfbu fb5dd840f4 Merge branch 'stable' 2017-03-03 09:53:50 +01:00
jfbu 4119439f3a Close #3489: bullet list rendered "opened up" 2017-03-02 14:56:27 +01:00
Yoshiki Shibukawa 0ef9ac54f1 Add experimental HTML5 writer 2017-03-02 09:56:50 +09:00
jfbu c28e1da763 Update (again) latex docs after PR##3429 2017-03-01 22:26:49 +01:00
jfbu bc67d4298f Improve latex tables: fix #1574 and other rendering issues
- allow multi-paragraph contents in grid table merged cells
- allow code-blocks in merged cells
- allow generally speaking reST contents allowed in regular
  cells to be also allowed in merged cells, whether multirow,
  multicolumn, or both.

This is made possible by custom LaTeX macros replacing original
``\multicolumn`` and ``\multirow`` (none of the originals allows
verbatim contents as is needed for code-blocks). They are defined in
bundled LaTeX style file sphinxmulticell.sty. The multicolumn merged
cells give much better results with tabulary as it is coerced into
taking them into account in its automatic width algorithm.

This deprecates use of LaTeX packages eqparbox and multirow, which are
not needed anymore.

New config setting ``latex_use_latex_multicolumn`` (default value False,
currently) as custom Sphinx multicolumn is not fully compatible will all
types of custom table col specs which may be inserted via tabularcolumns
directive. It works best with standard ``|`` column separator.

The default tabulary column specifier has been changed from L
(flushleft) to J (justifying). Internally the column type is called T,
so ``r'\newcolumntype{T}{L}'`` in preamble key recovers the former
behaviour. A ``\Y`` column type is defined which admits one decimal
argument in place of the two integers for ``\X``.
2017-03-01 09:41:30 +01:00
Takeshi KOMIYA a98818bf06 Merge pull request #3476 from stephenfin/feat/sphinx-setuptools-multiple-builders
setuptools: Support multiple builders
2017-03-01 15:30:33 +09:00
Takeshi KOMIYA 0b1178bff7 Merge branch 'stable' 2017-03-01 15:04:28 +09:00
Stephen Finucane 2afa0b6627 setuptools: Support multiple builders
At present, the 'builder' option for the setuptools integration only
supports a single output format, typically HTML, like so:

  [build_sphinx]
  builder = man

There is value in being able to specify multiple format, like so:

  [build_sphinx]
  builder = html man

Make this possible.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-02-28 17:30:28 +00:00
Takeshi KOMIYA 98d0be208c Merge branch 'master' into fix/epub_dublincore_validation_error 2017-03-01 00:22:15 +09:00
jfbu 5b5398768c Make `'extraclassoptions' key of latex_elements` public 2017-02-28 12:43:36 +01:00
Yoshiki Shibukawa 229c5cfa3b Add warning messages for required EPUB3 metadata 2017-02-28 19:51:39 +09:00
jfbu 434a32d1c8 Remove unneeded `{}` in LaTeX transition code 2017-02-28 10:00:41 +01:00
jfbu f282647e17 Update docs and CHANGES after PR#3429 2017-02-27 23:57:37 +01:00
Jean-François B efc2d06e4f Merge pull request #3429 from jfbu/xelatexfontspecclash
deprecate config setting ``latex_keep_old_macro_names`` at 1.6
2017-02-27 22:31:01 +01:00
Jean-François B 56d446cb42 Merge pull request #3466 from jfbu/lualatexsettings
same default settings for lualatex as for xelatex
2017-02-27 12:19:32 +01:00
jfbu b6eeb6e13e fix indentation in invocation.rst 2017-02-26 21:52:06 +01:00
jfbu ff700ae606 again update LaTeX requirements documentation 2017-02-26 13:26:23 +01:00
jfbu 7f1b9c0e5b update docs about LaTeX builder with required TeX install version 2017-02-26 11:45:20 +01:00
jfbu 4aa2318185 Revert "update LaTeX doc about dependencies"
This reverts commit dbf960884d.
2017-02-26 11:34:18 +01:00
Mike Fiedler a0d39222a7 Update latex.rst
typo & extra word removal

Signed-off-by: Mike Fiedler <miketheman@gmail.com>
2017-02-26 09:00:34 +01:00
Mike Fiedler b8dd3176b8 Update latex.rst
typo & extra word removal

Signed-off-by: Mike Fiedler <miketheman@gmail.com>
2017-02-25 20:17:37 -05:00
jfbu 40d99445f8 same default settings for lualatex as for xelatex
this requires fontspec sufficiently recent (TeXLive 2013 or later)
2017-02-26 00:13:06 +01:00
jfbu dbf960884d update LaTeX doc about dependencies 2017-02-25 14:52:26 +01:00