Commit Graph

174 Commits

Author SHA1 Message Date
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
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
Jeppe Pihl
5c48682cc9 added documentation for lineno-match option 2014-10-04 15:36:38 +02:00
Georg Brandl
a973daea41 make :any: role work with intersphinx! 2014-09-19 13:31:55 +02:00
Georg Brandl
109cb873de Use "any" role in changelog. 2014-09-19 13:18:29 +02:00
Georg Brandl
c3eb669f8a Added the any role that can be used to find a cross-reference of
*any* type in *any* domain.  Custom domains should implement the new
`~Domain.resolve_any_xref` method to make this work properly.
2014-09-19 12:59:18 +02:00
Georg Brandl
3645481458 merge with stable 2014-09-07 15:26:06 +02:00
Georg Brandl
294c83d8f0 Closes #1561: fix typo and indentation. 2014-09-07 15:24:50 +02:00
Takayuki Shimizukawa
d11267b205 Merge with stable 2014-08-30 20:20:19 +09:00
Takayuki Shimizukawa
0321402c9e pull request #130 has been merged by hand. 2014-08-25 13:37:18 +09:00
Takayuki Shimizukawa
a2410ec2ee Update CHANGES and documentation for PR#266. 2014-08-24 11:07:36 +09:00
shirou
4e70d364ba add test and document about diff params in literalinclude. 2014-08-12 14:11:54 +09:00
Takayuki Shimizukawa
d39327d539 * for pull request #258: update CHANGES, add tests, add a document and refactoring. 2014-08-10 23:03:02 +09:00
EricFromCanada
36313d98b1 corrected contractions 2014-06-18 12:52:32 -04:00
EricFromCanada
178a97cd73 improved consistency for how docs refer to True and False 2014-06-18 12:34:28 -04:00
EricFromCanada
65e924a3e4 rewrapping paragraphs when over 80 characters wide 2014-06-18 11:53:25 -04:00
David Bernard
7f78995d06 Expand tag documentation to include syntax requirements 2014-05-12 12:04:16 +10:00
Georg Brandl
1eb23c62ce merge with stable 2014-01-22 18:13:49 +01:00
Georg Brandl
38f47bc0ef Closes #1356: link to page with valid Pygments lexer alias 2014-01-22 17:28:04 +01:00
Georg Brandl
66e64b9530 merge with stable 2014-01-19 19:13:17 +01:00
Georg Brandl
ce49286240 Closes #1071: add mention of "orphan" to toctree docs 2014-01-19 18:12:52 +01:00
Georg Brandl
2458e5731a Add :filename: also for literalinclude. Changelog entry. 2014-01-19 11:04:12 +01:00
Georg Brandl
d133f028af merge with stable 2014-01-13 00:14:00 +01:00
Georg Brandl
a72406d434 Closes #1328: clarify that builder-specific tags are not available when conf.py is executed. 2014-01-12 22:40:50 +01:00
Georg Brandl
82e4751ed0 merge with stable 2014-01-12 17:04:58 +01:00
Georg Brandl
453290fc66 doc: make it more prominent that sub-toctrees shouldnt get :numbered:
Should be enforced programmatically at some point!
2014-01-11 19:54:47 +01:00