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,382 Commits 2 Branches 219 Tags 163 MiB
a8dabf334d
Commit Graph

1293 Commits

Author SHA1 Message Date
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
Georg Brandl
91887b0183 Merge branch 'stable' 2015-01-02 13:51:31 +01:00
Georg Brandl
a84e036622 development process updates: bb->gh, hg->git 2015-01-02 13:49:38 +01:00
Takayuki Shimizukawa
aa79c97da7 merge with stable 2014-12-05 19:44:05 +09:00
Takayuki Shimizukawa
c00dd30fb7 replace PIL with Pillow. 2014-12-03 23:13:21 +09:00
Takayuki Shimizukawa
292abeeedb update bundled ez_setup.py for setuptools-7.0 that requires Python 2.6 or later. 2014-12-03 23:17:48 +09:00
Takayuki Shimizukawa
6993a7254c fix documentation for extension development tutorial. Closes #1624. Thanks to dkeeney_fastacash. 2014-11-26 20:14:31 +09:00
Georg Brandl
6c194ad56f Closes #1623: Return types specified with `:rtype:` are now turned into links if possible. 2014-11-12 11:32:21 +01:00
Takayuki Shimizukawa
9bd306840f change a link for documentation translation page: from 1.2 to 1.3 2014-11-04 10:27:53 +09:00
Takayuki Shimizukawa
2710f705a1 fix: support python versions. 2014-10-30 10:13:54 +09:00
Takayuki Shimizukawa
dc482fd247 use reference to python 3.4 for intersphinx 2014-10-30 10:08:33 +09:00
Takayuki Shimizukawa
5bd2143fd0 enable sphinx.ext.viewcode for sphinx doc itself 2014-10-28 13:45:27 +09:00
Georg Brandl
96ce3b1374 Closes #1597: Added possibility to return a new template name from html-page-context. 2014-10-23 07:58:23 +02:00
Takayuki Shimizukawa
8b2f784dad Merged in westurner/sphinx-1/westurner/doc-invocationrst-sphinxapidoc-m-option-1413253549167 (pull request #308) 
DOC: invocation.rst: sphinx-apidoc -M option
 2014-10-22 00:24:48 +09:00
Wes Turner
5fb0c374e9 DOC: Add reference to markup/para.rst#glossary-directive from markup/inline.rst 2014-10-18 01:59:13 -05:00
Wes Turner
6bbd4c00d5 DOC: invocation.rst: sphinx-apidoc -M option 2014-10-14 02:25:56 +00: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
da651089e7 fix trailing space and long line 2014-10-09 23:53:33 +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
83e8bbf58b Add docs about :numref: role 2014-10-09 19:31:36 +09:00
tk0miya
e32883433a Update docs by reviewing 2014-10-09 01:41:51 +09:00
Takayuki Shimizukawa
b9a39f0ea0 Merged in shimizukawa/sphinx (pull request #305) 
gettext speed-up. closes #1426
 2014-10-09 00:59:39 +09:00
Takayuki Shimizukawa
27f89b9e99 fix documentation for websupport. 2014-10-09 00:57:01 +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
Jeppe Pihl
a3745cfb5e merge 2014-10-06 10:35:33 +02: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
Jeppe Pihl
5c48682cc9 added documentation for lineno-match option 2014-10-04 15:36:38 +02:00
Takayuki Shimizukawa
ecfeece952 pull request #299 has been merged. Add documentation for sphinx-quickstart options, update a few statement and CHANGES. Closes #1501. 2014-10-04 14:14:31 +09:00
tk0miya
7e59c5385e Merge with default 2014-09-28 21:56:20 +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
tk0miya
16529c5604 Add options argument to Sphinx.add_latex_package() 2014-09-28 21:10:26 +09:00
tk0miya
c04ad2908e Add new API: Sphinx.add_latex_package() 
Sphinx.add_latex_package() allows sphinx extensions to add latex packages.
It helps creating extensions for latex (for example, latex-theming)
 2014-09-27 12:47:27 +09:00
Georg Brandl
e3135cfc87 Make remaining builtin extensions parallel-read-proof. 2014-09-22 22:05:03 +02:00
Georg Brandl
52e5316b6e Document env-merge-info event, add parallel reading to changelog 2014-09-22 21:55:11 +02:00
Georg Brandl
31452fc64d [WIP] parallel read 2014-09-22 14:51:47 +02:00
Georg Brandl
71cd2f7e50 Change extension setup() return value to a dictionary of metadata. 
This makes it possible to introduce more metadata values later.
 2014-09-22 11:06:42 +02:00
Georg Brandl
7aa43488ea add a paragraph about sphinx-contrib on the front page 2014-09-22 10:20:02 +02:00
Georg Brandl
772dbbd4d9 Fix the docs index sidebar for unreleased versions. 2014-09-22 09:58:09 +02:00
Georg Brandl
e7ed7cd627 Rename env-read-docs to env-before-read-docs, add changelog entry and fixup tests. 2014-09-22 09:13:44 +02:00
Georg Brandl
3c5cda97d1 Merged in guillemNaN/sphinx (pull request #261) 
Add env-read-docs event to allow modify docnames list before processing
 2014-09-22 09:05:00 +02:00
Georg Brandl
24d303706f Fixup windows newlines. 2014-09-21 20:23:24 +02:00
Georg Brandl
db43cba254 add a bullet point about keeping tests fast 2014-09-21 18:59:56 +02:00
Georg Brandl
a973daea41 make :any: role work with intersphinx! 2014-09-19 13:31:55 +02:00
Georg Brandl
109cb873de Use "any" role in changelog. 2014-09-19 13:18:29 +02:00
Georg Brandl
c3eb669f8a Added the any role that can be used to find a cross-reference of 
*any* type in *any* domain.  Custom domains should implement the new
`~Domain.resolve_any_xref` method to make this work properly.
 2014-09-19 12:59:18 +02:00
Georg Brandl
6477151f4f Fix URL in docu for opensearch. 2014-09-19 11:57:06 +02:00
Gerard Marull Paretas
424a6b572b Added "libreoffice" extension to the extension list 2014-09-17 10:14:25 +00:00
Georg Brandl
bf6f5acd2c add distribution possibility 2014-09-14 17:26:13 +00:00
Georg Brandl
18ec1d79d3 Merged in hickford/sphinx-1/hickford/add-instructions-how-to-install-sphinx-t-1410715164407 (pull request #287) 
Add instructions how to install Sphinx to top of tutorial
 2014-09-14 19:24:45 +02:00
Matt Hickford
f5567e03fa Add instructions how to install Sphinx to top of tutorial 2014-09-14 17:19:32 +00:00
Matt Hickford
580458fce1 Explain how to install Sphinx with pip (rather than easy_install). Fixes #1447 2014-09-14 17:13:52 +00:00
Georg Brandl
3645481458 merge with stable 2014-09-07 15:26:06 +02:00
Georg Brandl
294c83d8f0 Closes #1561: fix typo and indentation. 2014-09-07 15:24:50 +02:00
Georg Brandl
ec329d54f2 Add extension version check ability with new config value "needs_extensions". 2014-09-04 08:57:36 +02:00
Georg Brandl
b6594d18d1 Add support for extensions to declare their version as a string returned from setup(). 2014-09-03 16:27:15 +02:00
Takayuki Shimizukawa
463a039957 less markup for README.rst, less emoticon for official. 2014-08-31 00:38:11 +09:00
Takayuki Shimizukawa
0cfb00db79 Add documentation to make contribution easier. 2014-08-31 00:02:01 +09:00
Takayuki Shimizukawa
d11267b205 Merge with stable 2014-08-30 20:20:19 +09:00
Takayuki Shimizukawa
f99e077dd4 Add documentation for supported image types and choosing priority for each builders. refs #1358. 2014-08-29 23:14:12 +09:00
Takayuki Shimizukawa
0321402c9e pull request #130 has been merged by hand. 2014-08-25 13:37:18 +09:00
Takayuki Shimizukawa
a2410ec2ee Update CHANGES and documentation for PR#266. 2014-08-24 11:07:36 +09:00
Takayuki Shimizukawa
0633892fde Update CHANGES for pull request #275, #1537; sphinx.ext.intersphinx supports multiple target for the inventory. 2014-08-23 12:07:59 +09:00
Takayuki Shimizukawa
aa744dda97 Merged in bsipocz/sphinx (pull request #275) 
Adding the option of multiple inv for the same name & uri
 2014-08-23 11:50: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
e8b870de0c :mod:~sphinx.ext.viewcode support imported function/class aliases. Closes #623 2014-08-22 11:38:56 +09:00
Brigitta Sipocz
64b915bdbe fix typo 2014-08-21 12:50:21 +01:00
Brigitta Sipocz
452f59af0e Addressing comment and adding docs 2014-08-21 12:47:32 +01:00
Takayuki Shimizukawa
60911efe05 Merge with tip 2014-08-18 23:20:42 +09:00
Shoji KUMAGAI
c1deefb545 add 'new in 1.3' marker 2014-08-15 16:49:11 +09:00
Shoji KUMAGAI
b71508d6fa Add theme contents for 'bizstyle' 2014-08-15 13:38:02 +09:00
Takayuki Shimizukawa
b8c2619858 Merged in r_rudi/sphinx (pull request #267) 
add 'diff' parameter to literalinclude.
 2014-08-13 13:17:47 +09:00
shirou
4e70d364ba add test and document about diff params in literalinclude. 2014-08-12 14:11:54 +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
d39327d539 * for pull request #258: update CHANGES, add tests, add a document and refactoring. 2014-08-10 23:03:02 +09:00
Jakob Lykke Andersen
640dfc1951 Merged birkenfeld/sphinx into default 2014-08-06 18:54:23 +02:00
Jakob Lykke Andersen
9230dd6a89 Doc, update C++ domain. 2014-08-06 18:54:00 +02: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
2e1c16486c * fix code to pass test, add versionadded to doc, update CHANGES for pull request #229 2014-08-03 19:19:31 +09:00
Takayuki Shimizukawa
9191ffaa50 Merged in russell/sphinx-pluggable-translators (pull request #229) 
Allow registration of other translators
 2014-08-03 18:52:02 +09:00
Takayuki Shimizukawa
eaed3ca9f1 Automatically compile `*.mo files from *.po` files. 2014-08-03 16:22:08 +09:00
Guillem Barba
b4b15181b4 Add env-read-docs event to allow modify docnames list before processing 2014-07-31 18:28:47 +02:00
Jakob Lykke Andersen
c19a15ea0d Doc, update C++ domain. 2014-07-27 11:42:01 +02:00
Lars Buitinck
5a13bce2e2 compress static PNG images with optipng -o10 
Average reduction in file size of 20%.
 2014-07-22 13:42:00 +02:00
Takeshi Komiya
024e8837cf Fix tx init command again. 2014-07-06 06:00:47 +00:00
Takeshi Komiya
65e83c6057 Do not enter password of transifex at command line by security reason 
Any command line options could be accessed by other users.
`tx init` command has interaction interface.
It should be used by all users by default.
 2014-07-06 05:09:16 +00:00
Takayuki Shimizukawa
c8e0a8759d Update documentation and sphinx-build -N option behavior for windows color console support. closes #1291. 2014-07-05 01:39:13 +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
Rob Ruana
71b8fe8854 Closes #1489: Removes use of ":annotation:" for attribute types in napoleon, as inline markup is not allowed 2014-06-13 14:06:39 -06:00
David Bernard
7f78995d06 Expand tag documentation to include syntax requirements 2014-05-12 12:04:16 +10:00
Takayuki Shimizukawa
638458038d tiny documentation fix 2014-04-28 19:41:14 +09:00
Rob Ruana
7f710be021 Updates Napoleon documentation per suggestion by a user 2014-04-26 19:43:46 -04:00
Jean-Paul Calderone
19533c96a5 Fix a copy/paste (presumably) mistake in the extdev tutorial. 2014-04-04 11:53:37 -04:00
Georg Brandl
04065625ed merge with stable 2014-03-26 07:30:55 +01:00
Georg Brandl
c24cfbaed1 Add an example how to connect events. 2014-03-26 07:30:48 +01:00
Russell Sim
45a0bcd453 Allow registration of other translators 
This adds an add_translator method to the sphinx application class.
It allows developers to register custom translators (writers) with
sphinx, so other extensions that add new nodes can register support
for the custom translators.
 2014-03-20 12:34:11 +11:00
Rob Ruana
18df6421bf Closes #1396: Param types with inline markup no longer italicized 
Napoleon was attempting to render nested inline markup
( [a big no-no!](http://sphinx-doc.org/rest.html) ) for
parameter types. Now, if Napoleon sees any backquotes
in the parameter type, it is rendered without italics.
 2014-03-09 01:56:56 -05:00
Georg Brandl
02363c3ce2 merge with stable 2014-03-06 08:13:14 +01:00
Georg Brandl
b944c843f5 Add warnings that autodoc imports the modules. 2014-03-05 07:45:45 +01:00
Georg Brandl
afd6c0b28d Merged in shibu/sphinx/add_stemmer (pull request #214) 2014-03-04 19:10:19 +01:00
Georg Brandl
85ddf03f45 merge with stable 2014-03-02 08:50:10 +01:00
Georg Brandl
501c2d13e6 Fix long lines. 2014-03-02 08:40:48 +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
Georg Brandl
d50c5efb1a Merged in kenhys/sphinx (pull request #217) 
Add feature to suppress uuid/location information for message catalogs
 2014-03-01 08:21:59 +01:00
Georg Brandl
c3836b3188 Merged in shimizukawa/sphinx-drop-old-docutils (pull request #206) 
Drop docutils-0.7, 0.8, 0.9 support.
 2014-03-01 08:20:21 +01:00
Georg Brandl
ac92719ac3 Update copyright year. 2014-03-01 08:18:23 +01:00
Georg Brandl
e030031321 Update copyright year. 2014-03-01 08:18:16 +01:00
Georg Brandl
cbf13620e2 merge with stable 2014-03-01 08:08:24 +01:00
Ernesto Revilla
d82590927f Allow alternative float options for figure. See #1. no-pep8 2014-02-20 18:03:34 +01:00
Robert Lehmann
529519275e Fixed W3C Validator errors in index page. 2014-02-05 15:06:59 +01:00
Georg Brandl
2a2b59598c link to extdev doc from develop 2014-02-02 08:03:48 +01:00
Georg Brandl
43d056dbe4 link to extdev doc from develop 2014-02-02 08:03:48 +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
Georg Brandl
eb79fcafea merge with stable 2014-01-26 11:51:09 +01:00
Georg Brandl
cf60ef0e75 Update list of extensions in sphinx-contrib. 2014-01-26 11:40:22 +01:00
Georg Brandl
25ac2dda9c add link 2014-01-24 20:22:58 +01:00
Georg Brandl
1eb23c62ce merge with stable 2014-01-22 18:13:49 +01:00
Georg Brandl
2acaf03270 Closes #1357: Option names documented by :rst:dir:option are now again allowed to 
not start with a dash or slash, and referencing them will work correctly.
 2014-01-22 17:42:38 +01:00
Georg Brandl
38f47bc0ef Closes #1356: link to page with valid Pygments lexer alias 2014-01-22 17:28:04 +01: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
fb5a1a09a0 some directive creation docs 2014-01-21 10:32:30 +01:00
Georg Brandl
6b33e3fea4 remove duplicate wording 2014-01-21 10:05:23 +01:00
Georg Brandl
cc8d29dcab actually use exception markup 2014-01-21 10:04:11 +01:00
Georg Brandl
da09100869 doc: add exceptions from sphinx.errors 2014-01-21 09:54:31 +01:00
Georg Brandl
317930a7fb merge with stable 2014-01-20 21:21:33 +01:00
Georg Brandl
fe5ac65311 Merged in ViktorHaag/sphinx/stable (pull request #211) 
Fix for issue #1352
 2014-01-20 21:16: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
Georg Brandl
883324fd6c Doc: move API docs in their own chapter and add more of it. 2014-01-20 17:21:44 +01:00
Viktor Haag
549b176c85 merge to tip 2014-01-20 10:37:51 -05:00
Viktor Haag
3706ed02ac address issue #1352 -- make sure to check for the actual file stored in config.html_logo. 2014-01-20 10:37:37 -05:00
Georg Brandl
aecf35c1bd mention loglevel 2014-01-20 11:21:30 +01:00
Georg Brandl
8115aa81a2 merge with stable 2014-01-20 08:54:40 +01:00
Georg Brandl
0e182d1d2b devguide: small updates 2014-01-20 08:51:47 +01:00
Rob Ruana
4219cd32c8 Merging changes 2014-01-19 13:44:28 -05:00
Rob Ruana
63fbb819c7 Makes suggested changes before adding napoleon to sphinx 2014-01-19 13:43:54 -05:00
Rob Ruana
3dcf8f4119 Merged birkenfeld/sphinx into default 2014-01-19 13:40:06 -05:00
Georg Brandl
66e64b9530 merge with stable 2014-01-19 19:13:17 +01:00
Rob Ruana
4c782604ed Merged birkenfeld/sphinx into default 2014-01-19 12:31:07 -05:00
Georg Brandl
ce49286240 Closes #1071: add mention of "orphan" to toctree docs 2014-01-19 18:12:52 +01:00
Georg Brandl
48aeed6fd8 add back missing @ 2014-01-19 17:49:57 +01:00
Georg Brandl
8c2fabe117 The deprecated config values `exclude_trees, exclude_dirnames and unused_docs` have been removed. 2014-01-19 17:46:06 +01:00
Georg Brandl
81b10b9b73 merge with stable 2014-01-19 17:41:41 +01:00
Georg Brandl
1653c5d242 Make mode: refactor using a class and add source dir to the makefile 2014-01-19 16:23:23 +01:00
Georg Brandl
411d88a90e Merged in birkenfeld/sphinx-new-make-mode/stable (pull request #203) 
Add "make mode" to sphinx-build, invoked by the -M flag.
 2014-01-19 15:38:23 +01:00
Georg Brandl
0d1aab9a45 Merged in keimlink/sphinx/improve-tags-docs (pull request #167) 
Explain that only tags set via command-line or tags.add() are available
 2014-01-19 11:09:42 +01:00
Georg Brandl
2458e5731a Add :filename: also for literalinclude. Changelog entry. 2014-01-19 11:04:12 +01:00
Georg Brandl
5023da8ac3 mock: little changes, changelog and versionadded 2014-01-19 10:34:52 +01:00
Georg Brandl
91cd11be3c Merged in guibog/sphinx2 (pull request #184) 
autodoc extension: add autodoc_mock_imports config value
 2014-01-19 10:31:15 +01:00
Rob Ruana
d11cb7325e Merge conflicts 2014-01-18 14:23:23 -05:00
Rob Ruana
a00a096069 Merges napoleon extension into mainline sphinx 2014-01-18 13:56:23 -05:00
Takayuki Shimizukawa
db9d91e8cc remove note it become useless anymore. 2014-01-18 21:47:20 +09:00
Takayuki Shimizukawa
c5bd935001 merge heads 2014-01-18 20:41:43 +09:00
Takayuki Shimizukawa
dd41adf0a0 merge heads 2014-01-18 16:34:47 +09:00
Georg Brandl
24a8b516bf Remove sphinx.ext.oldcmarkup compatibility extension. 2014-01-17 07:24:23 +01:00
Takayuki Shimizukawa
cc7509966c merge heads 2014-01-15 05:25:56 +00:00
Georg Brandl
dbd544d12b More tweaks to the py domain docs. 2014-01-13 20:13:44 +01:00
Georg Brandl
1723a09d72 merge with stable 2014-01-13 19:15:10 +01:00
Georg Brandl
78b5d9aac2 Overhaul py directive documentation, remove old practices. 2014-01-13 19:12:42 +01:00
Georg Brandl
d133f028af merge with stable 2014-01-13 00:14:00 +01:00
Georg Brandl
9708319f5c docs: fix some broken links 2014-01-13 00:05:22 +01:00
Georg Brandl
a72406d434 Closes #1328: clarify that builder-specific tags are not available when conf.py is executed. 2014-01-12 22:40:50 +01:00
Georg Brandl
dd73c32892 merge with stable 2014-01-12 20:46:50 +01:00
Georg Brandl
123572e1db #1345: Fix two bugs with :confval:nitpick_ignore; now you don't have to 
remove the store environment for changes to have effect.
 2014-01-12 20:45:34 +01:00
Georg Brandl
82e4751ed0 merge with stable 2014-01-12 17:04:58 +01:00
Georg Brandl
06364ca784 Closes #1174: Fix smart quotes being applied inside roles like :rst:role:program or :rst:role:makevar. 2014-01-12 17:01:22 +01:00
Georg Brandl
3f1235e2ea doc: note that "image" paths should not have spaces. 2014-01-12 16:28:27 +01:00
Georg Brandl
31aed07386 Closes #1156: bring manpage up to scratch with current options and builders. 2014-01-12 16:07:21 +01:00