Commit Graph

273 Commits

Author SHA1 Message Date
Georg Brandl
705f6a997b Merge branch 'apple-help' of git://github.com/al45tair/sphinx 2015-03-08 15:35:04 +01: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
1c6dcd8842 Merge branch 'source_suffix'
Conflicts:
	CHANGES
2015-02-27 21:09:15 +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
Georg Brandl
bf3bdcc7f5 source_suffix can now be a list. 2015-02-08 20:13:47 +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
Takayuki Shimizukawa
c00dd30fb7 replace PIL with Pillow. 2014-12-03 23:13:21 +09:00
Takayuki Shimizukawa
d289870f48 rename numfig_prefix to numfig_format. later is better for the purpose. 2014-10-10 00:19:17 +09:00
Takayuki Shimizukawa
2826af738d Merged in tk0miya/sphinx (pull request #303)
Add :numref: role to refer figures, tables and code-blocks by its fignum
2014-10-09 19:45:50 +09:00
tk0miya
e32883433a Update docs by reviewing 2014-10-09 01:41:51 +09:00
Takayuki Shimizukawa
90e9957240 fix grammar by review 2014-10-08 21:36:33 +09:00
tk0miya
18051a5110 Add docs about confval for numfig 2014-10-08 11:03:14 +09:00
Takayuki Shimizukawa
fa30e7b52a If the `python-levenshtein` 3rd-party package is installed, it will improve the calculation time. refs #1426. 2014-10-05 22:25:50 +09:00
Takayuki Shimizukawa
ee98decec1 Incompatibility. Now :confval:gettext_uuid is set False by default. If False, also levenshtein calculation is disabled. refs #1426 2014-10-05 21:50:44 +09:00
Takayuki Shimizukawa
9d1225a35b add :confval:gettext_enables to enable extracting 'index' to gettext catalog output / applying translation catalog to generated documentation. Closes #1344 2014-09-28 21:19:54 +09:00
Georg Brandl
6477151f4f Fix URL in docu for opensearch. 2014-09-19 11:57:06 +02:00
Georg Brandl
ec329d54f2 Add extension version check ability with new config value "needs_extensions". 2014-09-04 08:57:36 +02:00
Takayuki Shimizukawa
d11267b205 Merge with stable 2014-08-30 20:20:19 +09:00
Takayuki Shimizukawa
0321402c9e pull request #130 has been merged by hand. 2014-08-25 13:37:18 +09:00
Takayuki Shimizukawa
70fd3c6d31 :confval:templates_path is automatically added to :confval:exclude_patterns to avoid reading autosummary rst templates in the templates directory. Closes #1543 2014-08-23 09:04:21 +09:00
Takayuki Shimizukawa
60911efe05 Merge with tip 2014-08-18 23:20:42 +09:00
Takayuki Shimizukawa
954869df26 merge with stable 2014-08-12 06:42:57 +09:00
Takayuki Shimizukawa
8b60f04431 * adding new sphinx supported system languages. closes #1403.
* update all catalogs from transifex.
2014-08-11 21:57:06 +09:00
Takayuki Shimizukawa
f7399a261a Add app.set_translator() API to register or override a Docutils translator class like :confval:html_translator_class. 2014-08-05 00:18:54 +09:00
Takayuki Shimizukawa
eaed3ca9f1 Automatically compile `*.mo files from *.po` files. 2014-08-03 16:22:08 +09:00
EricFromCanada
4883e1eba2 more corrections for spelling and grammar 2014-06-19 12:14:47 -04:00
EricFromCanada
36313d98b1 corrected contractions 2014-06-18 12:52:32 -04:00
EricFromCanada
178a97cd73 improved consistency for how docs refer to True and False 2014-06-18 12:34:28 -04:00
EricFromCanada
65e924a3e4 rewrapping paragraphs when over 80 characters wide 2014-06-18 11:53:25 -04:00
EricFromCanada
8981b9bd13 corrections for misspellings 2014-06-18 11:19:01 -04:00
Georg Brandl
afd6c0b28d Merged in shibu/sphinx/add_stemmer (pull request #214) 2014-03-04 19:10:19 +01:00
Georg Brandl
0312edd266 Merged in erny1803/sphinx (pull request #227)
Latex: Allow alternative float options for figures
2014-03-01 08:56:53 +01:00
Georg Brandl
c403737ec3 Add versionadded tags for new config values. 2014-03-01 08:25:22 +01:00
Ernesto Revilla
d82590927f Allow alternative float options for figure. See #1. no-pep8 2014-02-20 18:03:34 +01:00
hayashi
e8503888bc Add feature to suppress uuid/location information for message catalogs
Before: default

  #: ../../../source/news.txt:6
  # 9f62de6b9c3b477095dba5e468972e6d
  msgid "News"
  msgstr

After: suppress uuid & location information

  msgid "News"
  msgstr
2014-02-01 02:34:09 +09:00
shibukawa yoshiki
6bda4586bd Add development memo about stemming JS code, acceleration tips about stemming, small bug fix 2014-01-22 02:12:04 -08:00
shibukawa yoshiki
18722362db update document 2014-01-22 00:34:14 -08:00
Georg Brandl
317930a7fb merge with stable 2014-01-20 21:21:33 +01:00
Viktor Haag
3c0c9cd198 updates per Georg Brandl:
- Change alteration to docs to express path relative to "configuration directory" and not "conf.py"
- Update block in HTML builder copying favicon to _static to mirror handling of html_logo
2014-01-20 13:27:52 -05:00