IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
6,788 Commits 2 Branches 219 Tags
7cfbc2a70267422986c816f254f6abf2f323e748
Commit Graph

1332 Commits

Author SHA1 Message Date
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
shimizukawa
04e3e761d7 tweak documentation: default is mercurial term. use master for git term instead. 2015-03-04 00:52:47 +09:00
shimizukawa
cdc4f5d8bb fix http/https 2015-02-28 01:10:03 +09:00
shimizukawa
332a912a47 fix http/https 2015-02-28 01:02:41 +09:00
shimizukawa
1c6dcd8842 Merge branch 'source_suffix' 
Conflicts:
	CHANGES
 2015-02-27 21:09:15 +09:00
Jakob Lykke Andersen
b1775cbf8c Add convenience directives and roles to C++ domain 
Add directive `cpp:var` and roles `cpp:var` and `cpp:any`.
Fixes sphinx-doc/sphinx#1577, fixes sphinx-doc/sphinx#1744.
 2015-02-26 21:44:46 +01:00
shimizukawa
720ef3dafe display pip install method for develop version 2015-02-25 16:25:50 +09:00
shimizukawa
68021b0bd3 refs #1346. Add new default theme. 
- Rename 'default' theme to 'classic'.
  - rename `themes/default` to `themes/classic`
  - add new `themes/default` theme that derives from 'classic' theme for compatibility.
- setup.py depends to 'alabaster' and 'rtd' theme.
- theming.py import and run `alabaster.get_path()` to append path for alabaster theme.
- theming.py also import and run `sphinx_rtd_theme.get_html_theme_path()` to append path.
- sphinx-quickstart will generate `html_theme = 'alabaster'`.
- If user use 'default', sphinx emit notice (WARNING) suggestion to use 'alabaster' or use 'classic'.
- add documentation for new alabaster and readthedoc theme and link to original pages:
  - https://pypi.python.org/pypi/alabaster
  - https://pypi.python.org/pypi/sphinx_rtd_theme
 2015-02-24 01:01:54 +09:00
shimizukawa
b0d40ea22c Closes #1735: Use https://doc.python.org/ instead of `http protocol. It was used for sphinx.ext.intersphinx` and some documentation. 2015-02-23 04:20:35 +00:00
shimizukawa
27c76fcb89 Closes #1227: Add html_auto_image_link config option to conf.py, to control scaled image link. 2015-02-22 22:04:20 +09:00
shimizukawa
bb85c1c87f refs #1235: i18n: 'uri' and 'alt' attribute on 'image' and 'figure' nodes can be translated if gettext_additional_targets has 'image'. 2015-02-22 19:35:49 +09:00
shimizukawa
0ad1c154c0 refs #1235: i18n: 'doctest-block' and 'raw' node can be translated if gettext_additional_targets has that string. 2015-02-22 15:40:01 +09:00
shimizukawa
c53fa4b369 refs #1235: i18n: 'literal-block' node can be translated if 'literal-block' is set to gettext_additional_targets. 2015-02-22 13:51:02 +09:00
shimizukawa
d5dca56ff8 The `gettext_enables config value has been renamed to gettext_additional_targets`. 2015-02-22 13:31:28 +09:00