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
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
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
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