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
5,664 Commits 2 Branches 219 Tags 163 MiB
af5edc31ee
Commit Graph

1167 Commits

Author SHA1 Message Date
Takeshi KOMIYA
01a526793d Fix typos #2122 (cherry-picked by hand) 2016-01-02 11:17:59 +09:00
Takeshi KOMIYA
87998df9cb Fix a documentation for sphinx.ext.viewcode 2015-12-27 01:32:40 +09: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
Takeshi KOMIYA
aa475604dc `figure_align` is added at 1.3 2015-12-03 23:31:54 +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
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
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
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
shimizukawa
a9afcb8831 Fix #1920 Minor documentation bug in windows install guide. 2015-06-07 17:08:06 +08:00
shimizukawa
2ee54dfd0b add make.bat for sphinx/doc 2015-04-06 14:18:28 +09: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
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
shimizukawa
3d3bee1c8b sphinx-quickstart now has --use-make-mode option for generating Makefile that use sphinx make-mode. 2015-02-17 21:42:27 +09:00
Robert Lehmann
3eb4afaa1a Document pass-through of language in HTML templates. 
Originally added in dee3e60.
 2015-02-14 10:02:04 +01:00
Jakob Lykke Andersen
44ee988981 C++, update docs and enums. Fixes sphinx-doc/sphinx#772. 2015-02-08 23:09:44 +01:00
Georg Brandl
bf3bdcc7f5 source_suffix can now be a list. 2015-02-08 20:13:47 +01:00
Jakob Lykke Andersen
d8a109976b Merge from master 2015-02-07 00:55:19 +01:00
Georg Brandl
accb32ff07 The `env-updated` event can now return a value, which is interpreted as an iterable of additional docnames that need to be rewritten. 
(reference: #1683)
 2015-01-25 16:13:04 +01:00
Alastair Houghton
5aa7f6bd80 Added some additional configuration variables for Apple Help. 
Removed Apple Help from quickstart conf.py.
Added support for .lproj directories with pre-localised files for Apple Help.
 2015-01-15 13:11:58 +00:00
Alastair Houghton
94847ad94e Fixed a typo. 2015-01-14 12:49:21 +00:00
Alastair Houghton
40728cf2ea Added documentation for Apple Help builder. 2015-01-14 12:45:04 +00:00
EricFromCanada
0f0ffbb982 revised pygments_style description 2015-01-06 10:51:54 -05:00
EricFromCanada
3111f7b6b3 rewording of highlight_options description 2015-01-05 23:22:19 -05:00
EricFromCanada
a63e4945ea Add highlight_options configuration value 
This changeset adds the `highlight_options` configuration value, which
specifies a dict of key-value pairs to pass to the Pygments highlighter
specified with `highlight_language`. For example, specifying
`highlight_options = {'funcnamehighlighting' : False}` for the 'php'
lexer will disable function name highlighting.
Both the HTML and LaTeX writers have been updated to include the
options when calling `highlight_block()`, as long as the currently
selected language matches what was set with `highlight_language`, i.e.
not when modified by `highlight::` or `code-block::` directives.
 2015-01-05 12:58:43 -05:00
Georg Brandl
a23903d8d5 Merge branch 'stable' 2015-01-03 21:41:14 +01:00
Georg Brandl
567d52f199 all: update copyright 2015-01-03 21:36:32 +01:00
Jakob Lykke Andersen
c010b47589 C++, initial enum support (see #772) 2015-01-03 16:59:08 +01:00