Commit Graph

1629 Commits

Author SHA1 Message Date
Takeshi KOMIYA
618ef6492c Merge pull request #1767 from Jellby/master
Allow setting 'rel' and 'title' attributes for stylesheets.
2017-04-19 00:04:43 +09:00
Takeshi KOMIYA
690f07fa3c Merge pull request #3388 from smheidrich/autosectionlabel_prefix_document1
Added autosectionlabel_prefix_document config option
2017-04-18 01:16:00 +09:00
Takeshi KOMIYA
f6d9c7d1d1 Merge branch 'master' into 3558_emit_warnings_for_unreferenced_footnotes 2017-04-18 01:08:50 +09:00
smheidrich
231976ff14 Added autosectionlabel_prefix_document config option. 2017-04-17 14:51:39 +02:00
Jellby
e59a8028d7 Rewrite and simplify stylesheet handling
Thanks to tk0miya's comment, I learnt one can add stuff to template
blocks, that allows a much simpler stylesheet configuration, considering
that changes at the template level will be more... well, low-level.
Hopefully this is now acceptable.
2017-04-15 17:07:33 +02:00
Jellby
1cfed262d2 Merge remote-tracking branch 'upstream/master'
Conflicts:
	tests/test_build_html.py
2017-04-15 15:54:06 +02:00
Brecht Machiels
3dd256fe7d Do not include the builder class in the entry point
- use the entry point to load the extension module in the usual way
- update the documentation to reflect this change
2017-04-14 11:01:09 +02:00
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
01cb3a75c7 Fix #3558: Emit warnings if footnotes and citations are not referenced 2017-03-18 21:03:16 +09: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
Jellby
68cf06a2ce Update version (there's still hope) 2017-03-04 12:14:54 +01:00
Jellby
3ce6168958 Merge remote-tracking branch 'upstream/master'
Conflicts:
	tests/test_build_html.py
2017-03-04 12:03:15 +01: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