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
13,361 Commits 2 Branches 219 Tags 163 MiB
afefeebb52
Commit Graph

177 Commits

Author SHA1 Message Date
Takeshi KOMIYA
2df0bb8d03 `sphinx.util.compat.Directive` class is now deprecated. 2016-12-13 11:36:03 +09:00
Takeshi KOMIYA
d72954d498 builtin extensions return metadata to allow parallel build 2016-12-12 21:22:16 +09:00
Takeshi KOMIYA
8a06a42c31 Add type-check annotations to sphinx.domains 2016-11-16 12:06:22 +09:00
Ashley Whetter
ea86d23845 Python domain can link multiple types in a type field 2016-09-18 06:38:27 +01:00
Ashley Whetter
cfd4e51802 Python domain can now link container types automatically 
Google types now greedily match the closing parenthesis.

Also removed name from returns section in Google docstrings.
Instead, everything before the colon is treated as the type.
 2016-08-03 17:09:40 +01:00
Glenn Matthews
8c1a8153ca Create PyGroupedField and use it for 'exceptions' 2016-07-15 22:01:06 -04:00
Takeshi KOMIYA
8a45aa5e59 Now all builders and domains work as built-in extensions 2016-07-06 23:25:45 +09:00
shimizukawa
e6a5a3a92e classifier of glossary terms can be used for index entries grouping key. The classifier also be used for translation. See also :ref:glossary-directive. 2016-02-14 19:28:58 +09:00
Georg Brandl
46d7e8558e Obligatory copyright update. 2016-01-14 22:54:04 +01:00
shimizukawa
70612c610f fix #1772 cross reference in docstrings like `:param .write:` breaks building. 2015-03-14 18:54:20 +09:00
Georg Brandl
ba9dcaac51 more pep8 fixes 2015-03-08 16:59:27 +01: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
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
Georg Brandl
31452fc64d [WIP] parallel read 2014-09-22 14:51:47 +02:00
Georg Brandl
6ba8883685 Add ref context to all "any" references. Should make it possible to resolve them more accurately. 2014-09-20 19:23:25 +02:00
Georg Brandl
2c396601bf Move env.temp_data content that might be used to resolve references to a new env.ref_context dictionary. 2014-09-20 19:15:41 +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
Takayuki Shimizukawa
da20c3713b merge with stable 2014-07-13 11:43:12 +09:00
Takayuki Shimizukawa
91709946d6 * Fix: py:function directive generate incorrectly signature when specifying a default parameter with an empty list []. Closes #1503 2014-07-12 20:50:15 +09:00
Takayuki Shimizukawa
49944cfa52 wrap iterator with list() to avoid 'dictionary changed size during iteration' on py3. refs #1350. 2014-04-29 22:43:58 +09:00
Takayuki Shimizukawa
ce4d342e20 use six privided iteritems(),itervalues() to support py2/py3 in one source. refs #1350. 2014-04-29 21:20:56 +09: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
fc82989a35 merge with stable 2014-01-12 20:30:25 +01:00
Georg Brandl
12b3b49f22 Closes #1233: Allow finding both Python classes and exceptions with the "class" and "exc" roles in intersphinx. 2014-01-12 17:19:58 +01:00
Virgil Dupras
ea02a07562 Allow "." and "~" prefixes in inline :param: typedefs. 2014-01-04 21:40:52 -05:00
Georg Brandl
ff33545457 Closes #1159: do not emit duplicate inventory entries for py:module objects. 
Also add a workaround on the consumer side in intersphinx, so that links
to projects using old versions of Sphinx generate correct links.
 2013-09-16 07:54:12 +02:00
Georg Brandl
151856819c Copyright update. 2013-01-01 22:13:15 +01:00
Georg Brandl
a6512317bf Closes #864: Fix crash with some settings of :confval:modindex_common_prefix. 2012-01-29 10:43:31 +01:00
Georg Brandl
5727c053c2 Closes #859: Fix exception under certain circumstances when not finding appropriate objects to link to. 2012-01-29 10:25:34 +01:00
Georg Brandl
9a4a3c9afa Satisfy "make check". 2011-10-09 23:09:57 +02:00
Georg Brandl
4abbe95a9c Merge with 1.0 2011-09-23 11:03:23 +02:00
Georg Brandl
db87ed440c Fix #648: Fix line numbers reported in warnings about undefined references. 2011-09-23 09:46:24 +02:00
Georg Brandl
25d41d8ed1 Merge with 1.0 2011-09-23 08:06:12 +02:00
Georg Brandl
6e81a0622a Fix pyflakes issues. 2011-09-22 15:34:26 +02:00
Georg Brandl
5ca496847a Closes #669: Respect the `noindex` flag option in py:module directives. 2011-05-15 13:00:11 +02:00
Georg Brandl
7e3151dd73 #581: Fix traceback in Python domain for empty cross-reference targets. 2011-01-04 23:39:13 +01:00
Georg Brandl
0e1db6ad90 New year update. 2011-01-04 10:00:51 +01:00
Georg Brandl
205d50a01d Regression of #77: If there is only one parameter given with `:param:` markup, the bullet list is now suppressed again. 2011-01-03 23:08:13 +01:00
Georg Brandl
10287a6684 merge with 1.0 2011-05-15 13:52:48 +02:00
Georg Brandl
dc0c43da9a #437: autodoc now shows values of class data attributes. 2011-01-08 23:45:58 +01:00
Georg Brandl
a86d481925 #507: Fix crash parsing Python argument lists containing brackets in string literals. 2010-08-23 15:20:22 +00:00
Georg Brandl
580e1c90d3 #481, #482: fix `.name` reference matching. 
#482: When doing a non-exact search, match only the given type of object.
#481: Apply non-exact search for Python reference targets with ``.name`` for modules too.
 2010-08-05 13:39:23 +02:00
Georg Brandl
7139a1c882 The :rst:dir:py:module directive doesn't output its `platform` option value anymore. 
(It was the only thing that the directive did output, and therefore quite inconsistent.)
 2011-01-08 16:09:49 +01:00
Georg Brandl
c6028c4405 #478: Added :rst:dir:py:decorator directive to describe decorators. 2011-01-08 10:07:42 +01:00
Georg Brandl
bf767d5222 #454: Add more index markup capabilities: marking see/seealso entries, and main entries for a given key. 2011-01-07 19:00:29 +01:00
Georg Brandl
e8b0511fdc merge with 1.0 2011-01-04 23:40:57 +01:00
Georg Brandl
17efae5622 merge with 1.0 2011-01-04 11:29:09 +01:00
Georg Brandl
3642b521ed merge with 1.0 2011-01-04 00:35:27 +01:00
Georg Brandl
1961292029 merge with 1.0 2010-08-23 16:27:25 +00:00
Georg Brandl
630791c42c Docstring harmonization. 2010-08-22 11:36:08 +02:00
Georg Brandl
09e6001e7a In the Python domain, references like `:func:.name``` now look for 
matching names with any prefix if no direct match is found.
 2010-06-12 10:41:56 +02:00
Georg Brandl
5b7e794e2b #413: Added a way for intersphinx to refer to named labels in other 
projects, and to specify the project you want to link to.
 2010-05-23 13:06:01 +02:00
Georg Brandl
f5ccb53294 merge with 0.6 2010-05-23 10:48:40 +02:00
Georg Brandl
6b191b22f1 Port 0f8b5391a6c2 to domains: Fix references to methods without a module. 2010-02-28 14:54:56 +01:00
Georg Brandl
04f660d021 Change domain-index API: introduce a class. 2010-02-28 14:45:43 +01:00
Georg Brandl
c2289a17b5 Add missing option_spec for Python domain. 2010-02-28 09:21:24 +01:00
Georg Brandl
1ad03286c0 Add method for adding custom indexes. 2010-02-21 21:49:38 +01:00
Georg Brandl
7f8f3f86b6 Get rid of the "module" node. 2010-02-20 14:45:39 +01:00
Georg Brandl
ed6562960c Remove "group" identifier from get_index() entries; let the template figure that out. 2010-02-20 14:21:03 +01:00
Georg Brandl
454ecf80a4 Make the concept of "module index" generalized to domains. As a side-effect, the latex modindex is no longer generated by LaTeX. 2010-02-20 01:13:23 +01:00
Georg Brandl
bc6085b8a5 Add missing docstring, add missing object types for Python domain. 2010-01-17 20:06:51 +01:00
Georg Brandl
dfa5ef2375 Rename doc_read_data to temp_data, which reflects better what it does. 2010-01-17 19:46:47 +01:00
Georg Brandl
98bcd2fab4 Make the _ gettext alias an explicit import instead of installing into builtins. 2010-01-17 19:33:23 +01:00
Georg Brandl
bacb6435e4 merge with trunk 2010-01-17 17:52:51 +01:00
Georg Brandl
a6b1a17ad6 Fix doc field type roles. 2010-01-17 12:29:29 +01:00
Georg Brandl
c98236bc61 Finish new doc field handling implementation. 2010-01-17 12:05:44 +01:00
Georg Brandl
cc35b402d9 Note the full name on the signature node. 2010-01-13 23:43:09 +01:00
Georg Brandl
65b426b22b Rename parse_signature() to handle_signature(); allows more to happen. Record module and class name in Python object descriptions. 2010-01-13 20:58:44 +01:00
Georg Brandl
54a31c5a6f Change naming convention in doc_read_data to "domain:key". 2010-01-13 20:45:34 +01:00
Georg Brandl
c37ddd0a6f Add some XXXes... sigh. 2010-01-08 18:54:41 +01:00
Georg Brandl
38e120848f Update copyrights. 2010-01-02 21:14:10 +01:00
Georg Brandl
407b41536d merge with trunk 2009-11-09 00:37:42 +01:00
Georg Brandl
bd66ba5179 Rename py domain specific refnode attributes. 2009-09-09 19:36:11 +02:00
Georg Brandl
92aa430241 search: make the search work with the new domain model. 2009-09-08 00:04:25 +02:00
Georg Brandl
fa7f8812cd More refactoring for language-independent domain support. 
* Renamed "desc"ription unit to "object" wherever possible.
* Added standard x-ref types to a StandardDomain which is always consulted.
* Split domains module into a subpackage.
* Removed additional_xref_types in favor of new directive classes in StandardDomain.
* Implemented x-ref inventory version 2, for all object types.
* Added env.doc_read_data which is for temporary data stored while reading.
* Minimally updated extension tutorial.
* Started to implement changes to interactive search.
* Test suite passes again.
 2009-09-07 22:52:26 +02:00