Takeshi KOMIYA
4250052eda
doc: Fix markup
2016-11-06 20:37:07 +09:00
Takeshi KOMIYA
463ab88b67
docs: sourcename has empty value on creating genindex and so on (refs: #3094 )
2016-11-04 23:36:27 +09:00
Yoshiki Shibukawa
6ee4289a95
Fix doc/Makefile that can't build man because of doc/man folder exists
2016-10-13 22:25:22 +09:00
Takeshi KOMIYA
3eb56b1c6f
doc: Use AutodocReporter at example of nested_parse_with_titles()
...
In detail, please refer following thread:
https://groups.google.com/forum/#!topic/sphinx-dev/l4fHrIJfwq4
2016-09-07 15:46:20 +09:00
Yoshiki Shibukawa
dd09457d7e
fix document: rtd is optional from 1.4
2016-08-23 18:42:12 +09:00
Yoshiki Shibukawa
90b3c79895
fix html entity to fix epub error
2016-08-09 16:58:56 +09:00
Yoshiki Shibukawa
8f162a132e
fix epub warning in Sphinx's document
2016-08-09 16:58:56 +09:00
Yoshiki Shibukawa
59ebeb7f1f
fix epub3 toc.xhtml, epub date format to satisfy spec
2016-08-09 16:58:56 +09:00
Eric Knibbe
56ee02114a
remove extra colons in C++ domain examples
2016-08-02 15:22:50 -04:00
Takeshi KOMIYA
c698fab338
Merge pull request #2786 from shibukawa/fix/epub
...
Reduce epub checker warnings/errors for epub3 builder.
2016-07-20 23:30:59 +09:00
Yoshiki Shibukawa
b7b1ac1c4d
add preferred instruction to download role description
2016-07-19 23:35:49 +09:00
Yoshiki Shibukawa
702004acfc
fix document download roles. download roles works only on html.
2016-07-19 23:15:35 +09:00
Yoshiki Shibukawa
06a861703d
Reduce epub checker warnings/errors for epub3 builder.
...
Fix DOCTYPE to html5 and change extension from .html to .xhtml.
Sphinx's documents result:
before: 95 warnings& 1238 errors
after: 623 errors
2016-07-17 09:53:04 +09:00
jfbu
f30a8d5a36
fix a mark-up typo in doc/install.rst
2016-06-30 11:10:58 +02:00
jfbu
5510653d6e
Fix #2629 . Add new config option `latex_keep_old_macro_names`
...
The cause of the issue was a clash about ``\titleref`` macro being already
defined in memoir class context. To avoid similar problems, this makes
the text styling macros
``\strong``, ``\code``, ``\bfcode``, ``\email``, ``\tablecontinued``,
``\titleref``, ``\menuselection``, ``\accelerator``, ``\crossref``,
``\termref``, ``\optional``,
also available with ``\sphinx`` prefix, with a conf.py boolean option to
let sphinx.sty only define ``\sphinx``-prefixed macros. As default value
is False, backwards compatibility is maintained.
On this occasion, some internal non-public macros have been renamed with
prefix ``\spx@``. The command
find . -name '*.sty' -exec grep -l \\\\spx@ {} \;
has been executed in TeXLive 2015 and 2016 installations to check no
package defines macros starting with ``\spx@``.
Some internal macros having public names (because they are written by
latex.py into the body of the latex document) have been renamed to have
``\sphinx`` prefix. The macros in sphinx.sty starting with \py@, or \DU,
or \PYG have not been modified. Similarly ``\release``, ``\version``,
``\releasename``, etc... have not been renamed.
2016-06-15 08:53:24 +02:00
jfbu
7d3bddd4e3
Convert text into links at bottom of tutorial.rst and top of config.rst
2016-06-09 15:34:59 +02:00
jfbu
f38665b58c
Display correctly the Builtin themes in the PDF build of Sphinx doc
...
Add longtable as class, which will allow pagebreaks in pdf output.
2016-06-06 14:42:58 +02:00
Takeshi KOMIYA
7661a92fc1
Update docs; the inputenc hack will be released at 1.4.3
2016-05-31 10:07:03 +09:00
Avram Lubkin
197b33816f
Only add '\\usepackage[utf8]{inputenc}' when using pdflatex
2016-05-31 10:02:58 +09:00
Takeshi KOMIYA
98c27003d0
Update description of numref option (ref: #2384 )
2016-05-27 23:40:01 +09:00
barbara-sfx
2038932b83
Add info on inline web link syntax
2016-05-06 09:13:48 -07:00
nevimov
0960f0d9f2
Split doctest extension docs into sections
...
At the moment the docs have no sections at all. This commit adds
sections "Directives" and "Configuration" to facilitate navigation.
Also, it removes the outdated line about the number of directives
provided by the extension (there’s now 5 of them).
2016-05-02 02:02:55 +07:00
nevimov
7ead796168
Fix code example in "HTML theming support" docs
...
- replaces invalid js-style comments with valid python
- shortens the comments so they don't need l10n
2016-04-26 19:14:53 +07:00
Takeshi KOMIYA
59c40c24f3
Add warning for Application.add_source_parser()
2016-04-24 13:57:32 +09:00
Takeshi KOMIYA
52c7867d14
Fix #2466 : Allow image.data_uri and image.nonlocal_uri as confval of suppress_warnings
2016-04-22 11:14:46 +09:00
shimizukawa
d5c36e045b
update devguide: following current procedure to run test
2016-04-18 14:36:25 +09:00
Takeshi KOMIYA
21ee53df2d
Define new warning types for suppress_warnings (ref #2451 )
2016-04-16 12:43:03 +09: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
d35ccb9b4c
The default format of today_fmt and html_last_updated_fmt is back to strftime format again
...
`html_last_updated_fmt` is commonly used for non date formatting. But
LDML is difficult to represent them from its characteristics.
Now we moved to strftime format again (ref: #2394 ).
2016-04-03 10:25:32 +09:00
Jakob Lykke Andersen
c6ba3093fe
C++, make prefixes of type declarations better.
...
Type declarations are now using the prefixes ``typedef``, ``using``, and ``type``,
depending on the style of declaration.
See also michaeljones/breathe#243 and michaeljones/breathe#242 .
2016-03-30 16:55:02 +09:00
Takeshi KOMIYA
da94ca5699
Merge branch '2327_toplevel_sectioning'
2016-03-03 20:41:17 +09:00
Takeshi KOMIYA
3939c4d684
Merge branch '2229_suppress_warnings'
2016-03-03 20:40:38 +09:00
Takeshi KOMIYA
110c2b0dbc
Fix #2327 : Add latex_toplevel_sectioning to switch the top level sectioning of LaTeX document.
2016-03-02 11:18:08 +09: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
Takeshi KOMIYA
2441c647d2
Fix #2229 : no warning is given for unknown options
2016-02-23 12:23:06 +09:00
Takeshi KOMIYA
ae9d786390
Add :confval:suppress_warnings to supress arbitrary warning message
2016-02-23 12:23:06 +09:00
Takeshi KOMIYA
84fb1b7617
Fix #2245 : Add `latex_elements["passoptionstopackages"]` option to call PassOptionsToPackages in early stage of preambles
2016-02-23 00:14:03 +09:00
Takeshi KOMIYA
904163f5b6
Merge pull request #2276 from tk0miya/1921_figure_substitutions
...
Fix #1921 : Support figure substitutions by locale
2016-02-22 23:55:53 +09:00
Takeshi KOMIYA
3f0843bca0
Add figure_language_filename to customize filename pattern for figure substitutions
2016-02-22 21:32:05 +09:00
Takeshi KOMIYA
1f5aa28db0
Fix #1921 : Support figure substitutions by locale
2016-02-22 21:32:05 +09:00
shimizukawa
cea8c85bf0
remove a part of description that mentioned about epub3 internal formating.
2016-02-22 10:36:39 +09:00
shimizukawa
905cbd09ed
Fix: ambiguous description for epub3_page_progression_direction conf value.
2016-02-22 10:20:28 +09:00
Takeshi KOMIYA
2b93e09c0a
Highlighting fallbacks by default
...
In 423bf7b
2016-02-20 00:44:28 +09:00
shimizukawa
a7ae5e39d9
fix wrong documentation
2016-02-15 09:45:04 +09:00
Takeshi KOMIYA
4452cc3d2e
Fix #794 : Date formatting in latex output is not localized
2016-02-14 21:48:24 +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
shimizukawa
0992ce542b
Closes #1853 : support custom text splitter on html search with language='ja'.
2016-02-14 19:23:51 +09:00
Takayuki SHIMIZUKAWA
e1394b5427
Merge pull request #2321 from sphinx-doc/py-3-highlighting
...
The default highlight language is now Python 3. Use it in viewcode as well.
2016-02-14 19:10:05 +09:00
Georg Brandl
d59f23b2c8
Fix highlight languages in docs.
2016-02-14 09:37:55 +01:00
Takeshi KOMIYA
Yoshiki Shibukawa
Eric Knibbe
jfbu
Avram Lubkin
barbara-sfx
nevimov
shimizukawa
Robert Lehmann
Jakob Lykke Andersen
Georg Brandl