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
16,450 Commits 2 Branches 219 Tags
6e445e117548dffcbb200d8200d09db6f673a3f7
Commit Graph

2908 Commits

Author SHA1 Message Date
Takeshi KOMIYA
f433581b04 doc: Fix highlight language 2021-01-10 22:22:30 +09:00
Takeshi KOMIYA
af4e615a8a Close #6241: html: Allow to add JS/CSS files to the specific page 
Allow to add JS/CSS files to the specific page when an extension calls
`app.add_js_file()` or `app.add_css_file()` on `html-page-context`
event.
 2021-01-07 02:12:07 +09:00
Takeshi KOMIYA
e9a4ebf70d doc: Add explanation for the priority attribute of html_*_files 2021-01-03 00:16:10 +09:00
Hong Xu
1f020196a7 DOC: modules are only available when recursive is on 
See
7ecf6b88aa/sphinx/ext/autosummary/generate.py (L314-L315)
 2021-01-01 11:12:58 -08:00
Takeshi KOMIYA
7ecf6b88aa Merge branch '3.4.x' into 3.x 2021-01-01 13:56:19 +09:00
Takeshi KOMIYA
f996859420 A happy new year! 
.. note::

   $ find sphinx tests LICENSE doc/conf.py -type f -exec sed -i '' -e 's/2007\-20../2007-2021/' {} \;
   $ git co sphinx/locale/**/*.js sphinx/templates/epub3/mimetype
 2021-01-01 13:40:48 +09:00
Takeshi KOMIYA
21698c1446 Merge pull request #8614 from tk0miya/deprecate_AttributeDocumenter_isinstanceattribute 
refactor: Deprecate AttributeDocumenter.isinstanceattribute()
 2020-12-30 19:47:17 +09:00
Takeshi KOMIYA
c99412695d Merge pull request #8292 from tk0miya/update_coding_style 
docs: Update coding style
 2020-12-30 01:44:03 +09:00
Takeshi KOMIYA
c0f923ee6c refactor: Deprecate AttributeDocumenter.isinstanceattribute() 2020-12-29 20:06:29 +09:00
Takeshi KOMIYA
150f788e0e Merge pull request #8600 from tk0miya/8132_project_copyright 
Close #8132: Add project_copyright confval as an alias of copyright
 2020-12-28 17:26:49 +09:00
Hong Xu
d9ca895dbb Update autodoc.rst 2020-12-27 21:24:19 -08:00
Hong Xu
6927130ff1 Doc: Correct type: "TypeAlias" -> "AliasType" 2020-12-27 21:23:31 -08:00
Takeshi KOMIYA
c5a9d04d45 Merge branch '3.x' into 8132_project_copyright 2020-12-28 13:56:11 +09:00
Takeshi KOMIYA
b19bce971e Merge pull request #8593 from tk0miya/8592_meta_public_doesnt_affect_to_variables 
Fix #8592: autodoc: `:meta public:` does not effect to variables
 2020-12-28 13:51:50 +09:00
Takeshi KOMIYA
ce52a90d92 Fix #8592: autodoc: :meta public: does not effect to variables 
To control the visibility of variables, ModuleDocumenter have to load
docstring of them on `get_object_members()` phase.  This reimplements
it and `get_module_members()` helper to fetch docstring on earlier
phase (as ClassDocumenter does).
 2020-12-27 22:21:34 +09:00
Takeshi KOMIYA
c7d1536828 Close #8132: Add project_copyright confval as an alias of copyright 
Avoid to pylint error, add a new config variable; project_copyright
as an alias of `copyright`.
 2020-12-27 18:40:06 +09:00
Takeshi KOMIYA
9e9e486e65 Close #8022: autodoc: Allow to hide the value of the variables via metadata 
autodata and autoattribute directives does not show right-hand value of
the variable if its docstring contains ``:meta hide-value:`` in
info-field-list.
 2020-12-27 12:46:03 +09:00
Takeshi KOMIYA
140ef33469 Fix #7875: doc: Add PythonDomain.note_object() 2020-12-26 21:12:15 +09:00
Takeshi KOMIYA
36e684bf83 refactor: Move _getmro() to sphinx.util.inspect module 2020-12-17 00:46:42 +09:00
Jon Dufresne
cb4f76fca2 Deprecate sphinx.util.osutil.movefile() in favor of os.replace() 
The utility function movefile() was added in
677d096393 to handle existing files on
Windows. Since Python 3.3, the stdlib function os.replace() fills this
role.
 2020-12-13 09:36:10 -08:00
Takeshi KOMIYA
399210c807 Merge pull request #8533 from tk0miya/deprecate_no_docstring 
refactor: Deprecate `no_docstring` argument for Documenter.add_content()
 2020-12-14 01:32:42 +09:00
Ned Batchelder
bac6ab8d0c Describe the intersphinx mapping a bit more 2020-12-13 08:04:55 -05:00
Takeshi KOMIYA
3638a9e4d1 refactor: Deprecate no_docstring argument for Documenter.add_content() 
This deprecates `no_docstring` argument for Documenter.add_content().
After this change, please use Documenter.get_doc() to control (suppress)
the content of the python object.
 2020-12-13 02:11:53 +09:00
Takeshi KOMIYA
bb63f03034 Fix #8503: autoattribute could not create document for a GenericAlias 2020-11-29 12:24:10 +09:00
Takeshi KOMIYA
da4c69c624 Merge pull request #8291 from QuentinSoubeyran/8285_napoleon_google_style_use_annotations 
Fix #8285: napoleon can use PEP526 annotations
 2020-11-28 18:11:30 +09:00
Takeshi KOMIYA
e6e23aa45b Merge pull request #8488 from tk0miya/deprecate_InstanceAttributeDecorator 
refactor: Deprecate InstanceAttributeDocumenter
 2020-11-26 20:13:03 +09:00
François Freitag
6b90a63f08 Fix #6629: linkcheck: Handle rate-limiting 
Follow the Retry-After header if present, otherwise use an exponential
back-off.
 2020-11-25 17:34:55 +01:00
Takeshi KOMIYA
93c9ce5cd8 refactor: Deprecate InstanceAttributeDocumenter 
InstanceAttributeDocumenter is merged into AttributeDocumenter in #7946
and #8444. So it is no longer needed now.
 2020-11-26 01:22:25 +09:00
Quentin Soubeyran
ec30f77712 refactored code and tests, prepared for numpy feature 2020-11-25 08:45:25 +01:00
Quentin Soubeyran
f268665292 added napoleon_google_attr_annotations option to use PEP 526 on google style 2020-11-25 08:45:25 +01:00
Takeshi KOMIYA
ab844c3f27 Deprecate SlotsAttributeDocumenter 2020-11-24 19:36:14 +09:00
Takeshi KOMIYA
5ebacaec89 Merge branch '3.x' into 8460_TypeVar 2020-11-23 13:58:41 +09:00
Takeshi KOMIYA
64498ad0db Merge pull request #8464 from tk0miya/deprecate_Documenter.get_object_members 
Deprecate Documenter.get_object_members()
 2020-11-23 13:24:20 +09:00
Takeshi KOMIYA
a57ce4047c refactor: Move _getannotations() to sphinx.util.inspect 2020-11-22 15:38:01 +09:00
Takeshi KOMIYA
9eb96d5c79 Fix #8460: autodata directive does not display the detail of TypeVars 
The details are only shown when automodule directive is used.  This
allows to document them via other auto* directives.
 2020-11-22 13:57:48 +09:00
Takeshi KOMIYA
8e29d57395 Rename ModuleAnalyzer.parse() to analyze() 
The word "analyze" is much appropriate for "ModuleAnalyzer" instead
of "parse".
 2020-11-22 02:59:29 +09:00
Takeshi KOMIYA
7e3ba5ddf6 Deprecate Documenter.get_object_members() 
At present, the implementation of Documenter.get_object_members() is
only for class objects.  In fact, no subclasses use it (all of them are
overriding the method).

This deprecates Documenter.get_object_members() and copies it to
ClassDocumenter.get_object_members().
 2020-11-21 15:42:46 +09:00
Takeshi KOMIYA
f344fff55e Fix #8443: autodata directive does not support PEP-526 ivars 2020-11-20 22:38:58 +09:00
Takeshi KOMIYA
5676fdeb4e Rename :novalue: option to :no-value: option 
According to the existing options of autodoc directives, `:novalue:`
option is now renamed to `:no-value:` option.
 2020-11-15 14:20:30 +09:00
Marlon James
6082ce67a4 autodoc: document :novalue: option 2020-11-15 14:19:33 +09:00
Takeshi KOMIYA
78d407cf83 Update CHANGES for PR #8404 2020-11-14 18:55:25 +09:00
François Freitag
683635f5b4 linkcheck: Remove call to is_ssl_error() 
This method always returns False, it is dead code. The exception
checking stopped working because Requests library wraps SSL errors in a
`requests.exceptions.SSLError` and no longer throws an
`urllib3.exceptions.SSLError`. The first argument to that exception is
an `urllib3.exceptions.MaxRetryError`.
 2020-11-12 19:58:04 +01:00
François Freitag
0949735210 Sort imports with isort 
Keep imports alphabetically sorted and their order homogeneous across
Python source files.

The isort project has more feature and is more active than the
flake8-import-order plugin.

Most issues caught were simply import ordering from the same module.
Where imports were purposefully placed out of order, tag with
isort:skip.
 2020-11-11 13:19:05 +01:00
Takeshi KOMIYA
1955a08378 Merge branch '3.x' into 8105_incorrect_class_constructor 2020-11-08 12:34:09 +09:00
Takeshi KOMIYA
cad02e62e6 Fix #8375: URL of transifex project page 2020-11-05 23:52:59 +09:00
Takeshi KOMIYA
6d05b1aeb3 Fix #8105: autodoc: the signature of decorated class is incorrect 
In #7651, autodoc stops to undecorate the functions on getting the
signature from the callables.  But some kinds of decorators conceals
the correct signature because they pass through their arguments via
`(*args, **kwargs)`.

This restarts to undecorate the functions again as before #7651.
 2020-11-05 01:57:40 +09:00
Takeshi KOMIYA
c028fb7a40 Merge pull request #8359 from sphinx-doc/8349_sphinx-contrib 
doc: Update sphinx-contrib repos' URL (refs: #8349)
 2020-11-03 11:29:31 +09:00
Takeshi KOMIYA
0e98e9b1a8 Fix #6914: Emit a detailed warning when failed to resolve :ref: 
To be clear the ambiguous warning for missing-reference :ref:,
this separates the warning to missing-label and missing-caption.

To emit a warning dynamically, this also adds a new event:
`warn-missing-reference` to customize warning messages via event
handlers.
 2020-11-03 02:27:43 +09:00
Takeshi KOMIYA
11edef1a26 doc: Update sphinx-contrib repos' URL (refs: #8349) 2020-11-03 02:13:05 +09:00
Takeshi KOMIYA
b453be75c9 Fix #8298: sphinx-quickstart: Add :option:sphinx-quickstart --no-sep option 2020-10-26 01:12:36 +09:00