IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-09-03 20:52:55 -05:00
Code Issues Packages Projects Releases Wiki Activity
6,737 Commits 11 Branches 236 Tags
4ca84aba45109bad835bd300c8d9415b80c58269
Commit Graph
281 Commits
Author SHA1 Message Date
Yoshiki Shibukawa 702004acfc fix document download roles. download roles works only on html. 2016-07-19 23:15:35 +09:00
nevimov 0960f0d9f2 Split doctest extension docs into sections 
At the moment the docs have no sections at all. This commit adds
sections "Directives" and "Configuration" to facilitate navigation.
Also, it removes the outdated line about the number of directives
provided by the extension (there’s now 5 of them).
 2016-05-02 02:02:55 +07:00
Georg Brandl d59f23b2c8 Fix highlight languages in docs. 2016-02-14 09:37:55 +01:00
Takeshi KOMIYA 7a4f914f91 Fix #1286, #2099: Add `sphinx.ext.autosectionlabel` extension to allow reference sections using its title 2016-02-14 16:30:57 +09:00
Takeshi KOMIYA dca1669b2f Merge pull request #2300 from akruis/feature_autoclass_content_from__new__ 
Feature: enhance autoclass:: to use the docstring of __new__ if __init__ method's is missing of empty
 2016-02-14 14:45:25 +09:00
Georg Brandl 5e8642983b Fixup links in the documentation. 2016-02-13 16:00:46 +01:00
shimizukawa e2208c12a0 Update CHANGES and documentation for #1751. 2016-02-08 23:31:02 +09:00
Anselm Kruis 0311f33347 Feature: enhance autoclass:: to use the docstring of __new__ 
The method new is an alternative to __init__, but autoclass does not 
respect __new__. This commit enhances the directive autoclass:: to try
__new__ method's docstring, if __init__ method's docstring is missing or
empty.

The commit also adds tests and updates the documentation.
 2016-02-05 19:09:43 +01:00
Hong Xu 540400635a math: Add math_number_all to enforce numbering all displayed math. 2016-01-18 23:47:01 -08:00
Takeshi KOMIYA 0cbb29e342 Update docs for #2221 2016-01-19 00:53:10 +09:00
Takeshi KOMIYA 4c4450d958 Fix #656: Add `graphviz_dot option to graphviz directives to switch the dot` command 2016-01-18 23:56:05 +09:00
shimizukawa f824539119 merge with stable 2016-01-13 00:13:35 +09:00
Takeshi KOMIYA 8ea92359ba Fix warnings in CHANGES and docs 2016-01-12 13:36:12 +09:00
shimizukawa e5860fd75c Merge with '87998df9cbef2380345d436121e6bca43345d2bd' on stable 
Conflicts:
	tests/test_build_latex.py
 2016-01-10 10:21:27 +09:00
Takeshi KOMIYA 0ea518d563 Add sphinx.ext.githubpages to publish the docs on GitHub Pages 2016-01-06 22:14:57 +09:00
Hong Xu f233c604ef imgmath: Make the size of the displayed math customizable. 2015-12-29 15:14:04 -08:00
Hong Xu f68bfbdbb7 Update the pngmath doc to synchronize with imgmath 2015-12-29 15:14:04 -08:00
Takeshi KOMIYA 87998df9cb Fix a documentation for sphinx.ext.viewcode 2015-12-27 01:32:40 +09:00
shimizukawa bf1cc70996 Merge with 'stable' 2015-12-20 08:48:38 +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
shimizukawa 9ceea10a62 Merge with 'stable' 2015-11-29 23:10:21 +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
Rob Ruana e926ebb263 Updates #2053 [Napoleon] Updates documentation to indicate napoleon_include_special_with_doc = True by default 2015-11-17 20:13:55 -08:00
Sgiath abf8d86bb3 #2092: Update documentation 2015-10-19 20:24:19 +02: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
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
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
shimizukawa 86edaeb8c4 remove or update missing links. 2015-03-07 22:07:46 +09:00
shimizukawa 332a912a47 fix http/https 2015-02-28 01:02:41 +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
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 dc482fd247 use reference to python 3.4 for intersphinx 2014-10-30 10:08:33 +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 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
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
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
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