summaryrefslogtreecommitdiff
path: root/sphinx/ext/viewcode.py
Commit message (Collapse)AuthorAgeFilesLines
* A happy new year!Takeshi KOMIYA2022-01-011-1/+1
|
* Support docutils-0.18: Consume iterator of Element.traverse()Takeshi KOMIYA2021-10-271-2/+2
| | | | | | | Since 0.18, Element.traverse() returns an iterator instead of intermediate object. As a result, the return value is always considered as truthy value. And it becomes fragile when the caller modifies the doctree on the loop.
* Fix #9210: viewcode: crashed if non importable modules found on parallel buildTakeshi KOMIYA2021-05-121-4/+5
|
* refactor: Use PEP-526 based variable annotationTakeshi KOMIYA2021-04-081-1/+1
|
* Fix #8933: viewcode: Failed to create back-links on parallel buildTakeshi KOMIYA2021-02-261-1/+8
| | | | | | | | On parallel build mode, viewcode losts the back-links information on gathering results from each process. As a result, some back-links are missing in the generated viewcode pages. This fixes the merging back-links process for parallel builds.
* Sometimes _viewcode_modules can be False; don't crash when it isDustin Spicuzza2021-02-151-1/+5
| | | | - Fixes #8880
* Fix #8756: viewcode: highlighted code is generated even if not referencedTakeshi KOMIYA2021-01-251-0/+13
| | | | | viewcode does not purge unreferenced modules on incremental build. This adds env-purge-doc handler to clean them.
* Fix #8704: viewcode: anchors are generated in incremental buildTakeshi KOMIYA2021-01-221-13/+51
| | | | | | | | | | | The anchors for viewcode was generated in the reading phase only if supported builder is used. It causes anchors are missing on the incremental build after the build for non supported builder. This introduces `viewcode_anchor` node to insert the anchor even if non supported builders. They will be converted to the anchor tag in the resolving phase for supported builders. Or, they will be removed for non supported builders.
* Fix #8720: viewcode: module pages are generated for epub on incremental buildTakeshi KOMIYA2021-01-221-0/+4
| | | | | | | The module pages should be generated for epub only if enabled via configuration. But they are generated after the build for other viewcode-supported builders. This checks the current builder on generating module pages.
* refactor: viewcode: Fix type annotationsTakeshi KOMIYA2021-01-191-4/+4
|
* Merge pull request #8698 from tk0miya/8681_viewcode_incremental_buildTakeshi KOMIYA2021-01-191-1/+40
|\ | | | | Close #8681: viewcode: Support incremental build
| * Close #8681: viewcode: Support incremental buildTakeshi KOMIYA2021-01-191-1/+40
| | | | | | | | | | Now viewcode supports incremental build. It generates HTML files only when the original python code is updated from last build.
* | refactor: viewcode: Use a constant for dirnameTakeshi KOMIYA2021-01-181-7/+12
|/
* A happy new year!Takeshi KOMIYA2021-01-011-1/+1
| | | | | | | .. 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
* Sort imports with isortFrançois Freitag2020-11-111-1/+0
| | | | | | | | | | | | 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.
* Revert "viewcode: Fix viewcode raises NoUri error on resolving phase except ↵Takeshi KOMIYA2020-06-261-4/+2
| | | | | | | | on HTML builders" This reverts commit c2ef1ad7e507c86442eae76e1ad7182383e13c8d. The error was completely resolved by #7683. So this is no longer needed.
* viewcode: Fix viewcode raises NoUri error on resolving phase except on HTML ↵Takeshi KOMIYA2020-05-171-2/+4
| | | | builders
* Merge branch '2.x' into 3.xTakeshi KOMIYA2020-02-181-1/+1
|\
| * Fix #7137: viewcode: Avoid to crash when non-python code givenTakeshi KOMIYA2020-02-181-1/+1
| |
* | refactor: Update type annotations in sphinx.ext.*Takeshi KOMIYA2020-02-161-3/+5
| |
* | Merge branch '2.0'Takeshi KOMIYA2020-01-011-1/+1
|\ \ | |/
| * A happy new year!Takeshi KOMIYA2020-01-011-1/+1
| |
* | Merge branch '2.0'Takeshi KOMIYA2019-07-061-18/+12
|\ \ | |/
| * Migrate to py3 style type annotation: sphinx.ext.viewcodeTakeshi KOMIYA2019-07-041-20/+14
| |
| * Show deprecation warning for viewcode_importTakeshi KOMIYA2019-03-301-0/+1
| |
* | Drop features and APIs deprecated in 1.8Takeshi KOMIYA2019-03-301-10/+0
|/
* Give "nonl=True" value to logging.info() instead of intTakeshi KOMIYA2019-01-191-3/+0
|
* Make info messages more translatableTakeshi KOMIYA2019-01-091-2/+2
|
* Merge branch '1.8'Takeshi KOMIYA2019-01-021-1/+1
|\
| * A happy new year!Takeshi KOMIYA2019-01-021-1/+1
| |
* | Merge pull request #5805 from jdufresne/has-tag-strTakeshi KOMIYA2018-12-171-6/+1
|\ \ | | | | | | Remove unnecessary bytes/str type check from doctree_read()
| * | Remove unnecessary bytes/str type check from doctree_read()Jon Dufresne2018-12-161-6/+1
| | | | | | | | | | | | ModuleAnalyzer.code is always type str. Decoding is unnecessary.
* | | Remove unnecessary encoding cookie from Python source filesJon Dufresne2018-12-161-1/+0
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | In Python 3, the default encoding of source files is utf-8. The encoding cookie is now unnecessary and redundant so remove it. For more details, see the docs: https://docs.python.org/3/howto/unicode.html#the-string-type > The default encoding for Python source code is UTF-8, so you can > simply include a Unicode character in a string literal ... Includes a fix for the flake8 header checks to stop expecting an encoding cookie.
* | Replace all "unicode" type by "str"Takeshi KOMIYA2018-12-151-7/+6
| |
* | Fix annotations (minor fixes)Takeshi KOMIYA2018-12-031-6/+4
| |
* | Fix annotaions for extensionsTakeshi KOMIYA2018-11-281-1/+3
| |
* | Add sphinx.util.typing:unicode to help mypy-3 migrationTakeshi KOMIYA2018-11-241-0/+1
| |
* | Merge branch '1.8'Takeshi KOMIYA2018-11-011-1/+1
|\ \ | |/
| * Fix #5471: Show appropriate warning for deprecated APIsTakeshi KOMIYA2018-10-171-1/+1
| |
* | Remove use of six.iteritems()Jon Dufresne2018-09-111-3/+3
|/ | | | In Python 3, dict.items() is always an iterator.
* Plugins can resolve imported members for viewcodeAshley Whetter2018-08-131-1/+7
|
* Rename viewcode_import to viewcode_follow_imported_members (refs: #4035)Takeshi KOMIYA2018-05-071-2/+14
|
* Plugins can find source code for viewcodeAshley Whetter2018-04-241-11/+21
| | | | Fixes #4035
* Merge branch '1.7'Takeshi KOMIYA2018-03-181-2/+2
|\
| * Revert "Use typing.TYPE_CHECKING for typehints"Takeshi KOMIYA2018-03-131-2/+2
| | | | | | | | This reverts commit a073e17537c2aacaac305feadea58d4473ec97f4.
* | Merge commit '6694981dd6939ab876b27d4e20a8128561c307ac'Takeshi KOMIYA2018-03-151-1/+1
|\ \ | |/
| * Fix #4701: viewcode: Misplaced ``<div>`` in viewcode html outputTakeshi KOMIYA2018-03-051-1/+1
| |
* | Merge branch '1.7'Takeshi KOMIYA2018-02-181-2/+2
|\ \ | |/
| * Use typing.TYPE_CHECKING for typehintsTakeshi KOMIYA2018-02-141-2/+2
| |
* | Merge branch '1.7-release'Takeshi KOMIYA2018-01-311-2/+1
|\ \ | |/