Jakub Wilk
f86217c9d1
Fix typos.
2016-01-01 20:54:30 +01:00
Takeshi KOMIYA
3c907f2337
Fix #2027 : `make epub got errors if html_title` is None
...
Sphinx does not expect setting None value as ``html_title`` in
spite of documented.
This changed that to deny None value as ``html_title``.
2016-01-01 10:35:45 +09:00
Hong Xu
f233c604ef
imgmath: Make the size of the displayed math customizable.
2015-12-29 15:14:04 -08:00
Hong Xu
f68bfbdbb7
Update the pngmath doc to synchronize with imgmath
2015-12-29 15:14:04 -08:00
Takeshi KOMIYA
87998df9cb
Fix a documentation for sphinx.ext.viewcode
2015-12-27 01:32:40 +09:00
shimizukawa
bf1cc70996
Merge with 'stable'
2015-12-20 08:48:38 +09:00
Georg Brandl
8232707a12
merge stable to default
2015-12-18 21:42:55 +01:00
Hong Xu
691141d23f
sphinx.ext.graphviz: Add doc to explain how to make the links in svg output work.
2015-12-16 19:33:17 -08:00
daoiqi
d76a700fa2
add chinese search options into html_search_options document
2015-12-13 17:07:11 +08:00
Buck Evan
59c64a36c5
Merge branch 'master' into dummy-builder
2015-12-09 17:07:08 -08:00
shimizukawa
32d4ab51bd
Update CHANGES refs #1757
2015-12-09 17:00:40 +09:00
Takayuki SHIMIZUKAWA
8bfc9409ec
Merge pull request #1757 from hemmecke/master
...
fix unclear documentation for html_last_updated_fmt
2015-12-09 16:54:45 +09:00
Takeshi KOMIYA
aa475604dc
`figure_align` is added at 1.3
2015-12-03 23:31:54 +09:00
shimizukawa
9ceea10a62
Merge with 'stable'
2015-11-29 23:10:21 +09:00
shimizukawa
47bdbd1655
Fix #1818 : sphinx.ext.todo directive generates broken html class attribute as 'admonition-' when :confval:language is specified with non-ASCII linguistic area like 'ru' or 'ja'. To fix this, now `todo directive can use `:class:` option.
2015-11-29 12:02:02 +09:00
Jakob Lykke Andersen
89d7ab6941
C++, tparam info field docs.
2015-11-21 16:51:17 +01:00
Rob Ruana
e926ebb263
Updates #2053 [Napoleon] Updates documentation to indicate napoleon_include_special_with_doc = True by default
2015-11-17 20:13:55 -08:00
shimizukawa
8ae43b9fd4
Merge branch 'stable'
2015-11-15 18:07:23 +09:00
Takayuki SHIMIZUKAWA
c4850cc9ab
Merge pull request #2004 from cjmayo/theming
...
Stop theme description stretching around screenshots in html output
2015-11-15 16:51:45 +09:00
Rob Ruana
132791c852
Merge pull request #2093 from Sgiath/napoleon-todo
...
#2092 : Napoleon 'todo' directive
2015-11-12 14:02:48 -08:00
shimizukawa
9ff6eb55f8
fix typo
2015-10-27 22:52:44 +09:00
Sgiath
abf8d86bb3
#2092 : Update documentation
2015-10-19 20:24:19 +02:00
Jakob Lykke Andersen
5f09ecd4cf
C++, cross-reference update
...
(see also sphinx-doc/sphinx#2057 )
- Elaborate the documentation in regard to templates.
- Add shorthand for template declarations.
- Add shorthand for (full) template specialisations.
- Add better error messages for unparseable references.
2015-10-14 09:41:52 +09:00
shimizukawa
cdf74eb8d1
builders page indicates 'format' value for each builders. refs #2038
2015-09-15 10:25:50 +09:00
TAKASE Arihiro
5e1028db43
Fix the language code for Portuguese
2015-09-13 10:07:34 +09:00
TAKASE Arihiro
8e7166df1e
Fix the language code for Portuguese
2015-09-11 19:46:27 +09:00
Jakob Lykke Andersen
a22fb0d45f
C++, add namespace push/pop directives.
2015-09-06 22:28:55 +02:00
Jakob Lykke Andersen
89c3dd81c3
C++, support for templates.
...
Fixes sphinx-doc/sphinx#1729 .
2015-09-06 15:36:58 +02:00
Chris Mayo
888cdc0b14
Stop theme description stretching around screenshots in html output
2015-08-16 19:37:02 +01:00
shimizukawa
d51228152e
merge with stable
2015-07-25 18:15:09 +02:00
Georg Brandl
bf7d0ccd75
Fixes #1887 : note that graph name needs quotes if non alphanumeric.
2015-07-25 17:04:06 +02:00
shimizukawa
468568bdcf
fix obsoleted documentation
2015-07-25 15:55:43 +02:00
Edoardo Batini
4b64814f8f
Document `cmdoption` directive deprecation
2015-07-25 12:45:18 +02:00
kyleknap
cfb3a75953
Update `'releasename'` latex element docs
...
To address https://github.com/sphinx-doc/sphinx/issues/1782
2015-07-25 03:00:47 -07:00
Masafumi Yokoyama
2522afe94d
doc: adjust underline length of section headers
2015-07-22 00:51:10 +09:00
Hans Moritz Günther
6a40cbf0e0
Correct minor typo in confic.py
2015-07-12 10:08:36 -04:00
Takayuki SHIMIZUKAWA
445db4f958
Merge pull request #1830 from thomasvandoren/ref-chapel-domain-in-docs
...
Add reference to Chapel domain in domains document.
2015-07-11 15:25:12 +09:00
Robert Lehmann
f323b60641
Explicitly mention sphinx-users mailing list
...
This should now answer searches for "mailing list" and "sphinx-", in case users just skim the Web site.
I have checked this in a Web browser and it looks good IMO (box not overfull.)
2015-06-24 21:13:24 +09:00
Robert Lehmann
e8ab6cc44e
Explicitly mention sphinx-users mailing list
...
This should now answer searches for "mailing list" and "sphinx-", in case users just skim the Web site.
I have checked this in a Web browser and it looks good IMO (box not overfull.)
2015-06-24 13:32:01 +02:00
Buck Golemon
59dfb47c1c
add a dummy builder, for syntax checkers
2015-06-23 16:23:27 -07:00
jpic
9265010609
Link to Python's Style Guide for documentation.
...
This is a follow-up to #1931
2015-06-19 18:14:02 +02:00
Rob Ruana
27be6614f7
[Napoleon] Miscellaneous formatting fixes to napoleon example docstrings
2015-06-14 13:32:04 -07:00
Rob Ruana
d5d6556a8a
[Napoleon] Updates docs to use single quoted strings & 4-space indentation
2015-06-11 20:21:37 -07:00
Georg Brandl
bfdbee0d04
merge with stable
2015-06-11 19:07:10 +02:00
Rob Ruana
34add11b5d
Closed #1925 : [Napoleon] provides @property examples & recommends PEP 484 type hints in Napoleon docs
2015-06-09 18:18:22 -07:00
Takayuki SHIMIZUKAWA
20cba249ef
Merge pull request #1910 from bgeron/patch-1
...
Fix a typo in doc/markup/toctree.rst.
2015-06-08 06:47:49 +08:00
shimizukawa
a9afcb8831
Fix #1920 Minor documentation bug in windows install guide.
2015-06-07 17:08:06 +08:00
Takayuki SHIMIZUKAWA
381d9ef7c5
Merge pull request #1876 from ericholscher/source_suffix_in_build
...
Add suffix to doc context. Fixes #1873 .
2015-06-07 08:59:13 +08:00
Eric Holscher
5f6503c905
Add suffix to HTML context. Fixes #1873
2015-06-06 13:12:56 -07:00
Bram Geron
f1f4342e9a
Fix a typo in doc/markup/toctree.rst.
2015-05-29 12:51:01 +01:00
