Commit Graph

198 Commits

Author SHA1 Message Date
Takeshi KOMIYA
c399357f38 Show a notice if both tabularcolumns and :widths: are given (refs: #4196) 2018-01-14 22:23:18 +09:00
Antoine Beaupré
90f7c7ef3f
add link to manpages in HTML builder
It is useful to have the HTML documentation builder actually link to
real rendered versions of HTML manpages in its output. That way people
can click on manpages to get the full documentation. There are a few
services offering this online, so we do not explicitly enable one by
default, but the Debian manpages repository has a lot of the manpages
pre-rendered, so it is used as an example in the documentation.

The parsing work is done by a transformer class that parses manpage
objects and extract name/section elements. Those then can be used by
writers to cross-reference to actual sites. An implementation is done
in the two HTML writers, but could also apply to ePUB/PDF writers as
well in the future.

This is not enabled by default: the `manpages_url` configuration item
needs to be enabled to point to the chosen site. The `page`, `section`
and `path` parameters are expanded through Python string formatting in
the URL on output.

Unit tests are fairly limited, but should cover most common use-cases.
2018-01-11 13:20:34 -05:00
Takeshi KOMIYA
b094c401de docs: make explicitly :meth: reference (refs: #4344) 2017-12-27 14:59:59 +09:00
jfbu
fcbabcd9b5 Merge branch 'stable'
Conflicts:
	sphinx/apidoc.py
	sphinx/application.py
	sphinx/quickstart.py

	modified:   CHANGES
	modified:   doc/config.rst
	modified:   doc/markup/inline.rst
	modified:   sphinx/application.py
	modified:   sphinx/builders/__init__.py
	modified:   sphinx/cmd/quickstart.py
	modified:   sphinx/ext/apidoc.py
2017-12-18 10:13:49 +01:00
jfbu
ba1368072f Typo place holder --> placeholder 2017-12-16 11:51:00 +01:00
jfbu
a9602e4597 Improve numref docs 2017-12-16 11:46:33 +01:00
jfbu
ad4481eb15 Merge branch 'stable' 2017-12-11 22:54:34 +01:00
jfbu
3bbfbadce5 Add a note for future maintenance by TeX hackers 2017-12-10 16:51:10 +01:00
jfbu
c220ae3ecb Update docs relative to emphasize-lines 2017-12-10 16:20:00 +01:00
jfbu
70f8d4ddfc Support `:emphasize-lines:` in PDF output (closes #1238) 2017-12-10 12:37:36 +01:00
Takeshi KOMIYA
d59fdda8c9 Merge pull request #3905 from TimKam/1236-add-note-referencing-arbitrary-locations
#1236 add note: omit underscore in internal ref
2017-07-15 22:37:51 +09:00
Timotheus Kampik
328e57949e #1236 add note: omit underscore in internal ref 2017-07-02 15:19:47 +02:00
Timotheus Kampik
16a2367301 #2307 add :: to show markup sample, not evaluate it 2017-07-02 13:24:38 +02:00
jfbu
adc056200c Improve access to table and math markup info in docs 2017-06-20 15:57:32 +02:00
Takeshi KOMIYA
db6e1db5cb doc: Add warning for only directive (refs: #3539) 2017-03-12 01:47:11 +09: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
4941148c5d Merge branch 'stable' 2017-02-25 14:47:34 +09:00
jfbu
f0df6cff9b clarify description of tabulary (no "rescaling" of contents) 2017-02-24 15:48:00 +01:00
jfbu
651827946a Update CHANGES and docs for PR#3413 2017-02-17 23:30:01 +01:00
Jean-François B
a7becf30de Merge branch 'master' into literalincludelines 2017-02-13 19:38:22 +01:00
jfbu
58ea3caeac Revert "Improve docs about `:lines:̀ vs ̀:start-after:` (refs #3412)"
This reverts commit 839e924808.

Indeed, it is better not to document how to use ``lines`` with
``start-after`` now if this is to be changed at next major release (refs
2017-02-11 12:08:37 +01:00
jfbu
0a4588e7b0 Remove unneeded docs 2017-02-10 17:53:06 +01:00
jfbu
a2338e4838 If `:start-after: is used, make :lines:` relative (close: #3412) 2017-02-10 16:55:28 +01:00
jfbu
839e924808 Improve docs about `:lines:̀ vs ̀:start-after:` (refs #3412) 2017-02-10 14:35:58 +01:00
Jakub Wilk
a58ebedffd Fix typos 2017-02-07 20:14:47 +01:00
adrian5
7bf7b81751 Update toctree.rst 2017-01-31 01:29:18 +01:00
Takeshi KOMIYA
7c19a2f36a Fix #3118: Update document for numfig_format and numref 2016-11-20 12:46:30 +09:00
jfbu
54dbd3882d add advice on use of tabulary (latex output) 2016-10-20 15:47:38 +02:00
Takeshi KOMIYA
c8fe4a1848 Rename :reverse: option of toctree directive to :reversed: 2016-10-12 19:36:49 +09:00
Takeshi KOMIYA
8481ed3560 Merge remote-tracking branch 'JonhVillalovos/master' 2016-10-12 18:49:08 +09:00
Jean Jordaan
aa22bede25 Fix grammar and wording 2016-10-02 19:21:12 +07:00
Takeshi KOMIYA
2b10fc0188 Fix #2916: numref role can also refer caption as an its linktext 2016-09-17 15:51:18 +09:00
Takeshi KOMIYA
1aafc7e2e5 Fix #326: numref role can also refer sections 2016-09-17 15:51:18 +09:00
Yoshiki Shibukawa
b7b1ac1c4d add preferred instruction to download role description 2016-07-19 23:35:49 +09:00
John L. Villalovos
ca49c4c207 Add a 'reverse' flag option to 'toctree'
I'm not sure the best way to do the unit tests. A little confused. So
help would be appreciated :)

Add the ability to reverse the list of entries when using 'toctree'.
This is likely most useful for people using the 'glob' flag option with
'toctree'

Change-Id: I1852479106c3d9c8253fd1625ced0077af0304e3
2016-05-04 17:34:20 -07:00
Robert Lehmann
ca900593c0 Clear up Pygments is mandatory
While Pygments is not required for other builders, it is *always* used in the HTML builder.
2016-04-05 11:32:16 +02:00
Takeshi KOMIYA
c05a0f9904 Merge branch 'stable' 2016-03-02 11:15:55 +09:00
Takeshi KOMIYA
119b971804 update doc: LaTeX writer now refers maxdepth option (ref #2358) 2016-03-02 11:11:11 +09:00
shimizukawa
e6a5a3a92e classifier of glossary terms can be used for index entries grouping key. The classifier also be used for translation. See also :ref:glossary-directive. 2016-02-14 19:28:58 +09:00
Georg Brandl
5e8642983b Fixup links in the documentation. 2016-02-13 16:00:46 +01:00
Takeshi KOMIYA
e4b9eb51f6 Merge branch 'stable' 2016-01-11 00:27:26 +09:00
Takeshi KOMIYA
7894f0bd9c Fix #2225: If the option does not begin with dash, linking is not performed 2016-01-09 19:57:23 +09:00
Bram Geron
f1f4342e9a Fix a typo in doc/markup/toctree.rst. 2015-05-29 12:51:01 +01:00
shimizukawa
8fb6516256 fix typo. 2015-03-17 07:32:31 +09:00
shimizukawa
e2a921ff07 refs #1742: :name: option is provided for toctree, code-block and literalinclude dirctives. 2015-03-08 21:59:37 +09:00
shimizukawa
26ae055b2d refs #1700: now toctree caption become paragraph block instead of Text under ul element. and add permalink for toctree caption. 2015-03-08 16:45:56 +09:00
Takeshi KOMIYA
5e48ac9b4f Role `numref uses %s as special character instead #` symbol 2015-03-08 08:30:16 +09:00
Wes Turner
5fb0c374e9 DOC: Add reference to markup/para.rst#glossary-directive from markup/inline.rst 2014-10-18 01:59:13 -05:00
Takayuki Shimizukawa
2826af738d Merged in tk0miya/sphinx (pull request #303)
Add :numref: role to refer figures, tables and code-blocks by its fignum
2014-10-09 19:45:50 +09:00
tk0miya
83e8bbf58b Add docs about :numref: role 2014-10-09 19:31:36 +09:00