Commit Graph

1345 Commits

Author SHA1 Message Date
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
Georg Brandl
55368daa91 merge with stable 2015-05-18 14:26:44 +02:00
Jean Jordaan
56c51ff4b0 Some language edits while reading 2015-05-15 13:18:19 +08:00
Tomoko Uchida
1d22c20664 Add requirement notation for type 'janome'. 2015-04-18 18:22:42 +09:00
Tomoko Uchida
e3bc5bb077 Allow to choose Janome for Japanese splitter. 2015-04-18 17:05:14 +09:00
shimizukawa
2ee54dfd0b add make.bat for sphinx/doc 2015-04-06 14:18:28 +09:00
Thomas Van Doren
297f5f143d Add reference to Chapel domain in domains document. 2015-04-03 16:55:56 -07:00
Lukas Prokop
82345f5c11 speicifer -> specifier 2015-03-22 11:28:25 +01:00
shimizukawa
8fb6516256 fix typo. 2015-03-17 07:32:31 +09:00
shimizukawa
25251a3d53 Closes #1651: Documentation: add `vartype` field description for python domain. 2015-03-09 22:51:20 +09:00
Georg Brandl
548a6dc22e final pep8 fixes; reactivate most warnings in flake8 2015-03-08 17:15:54 +01:00
Georg Brandl
3437872b30 merge 2015-03-08 15:38:28 +01:00
Georg Brandl
705f6a997b Merge branch 'apple-help' of git://github.com/al45tair/sphinx 2015-03-08 15:35:04 +01:00
shimizukawa
e2a921ff07 refs #1742: :name: option is provided for toctree, code-block and literalinclude dirctives. 2015-03-08 21:59:37 +09:00
Georg Brandl
ad612fb03d Change the source parsers feature a bit:
* parsers -> source_parsers
* add docs
* require fully qualified name or class
* add test for it
2015-03-08 13:12:50 +01: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
shimizukawa
86edaeb8c4 remove or update missing links. 2015-03-07 22:07:46 +09:00
Ralf Hemmecke
2c58eef1d1 fix unclear documentation for html_last_updated_fmt 2015-03-07 09:06:58 +01:00