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
18,064 Commits 2 Branches 219 Tags 163 MiB
80fbbb8462
Commit Graph

110 Commits

Author SHA1 Message Date
Jake Lishman
9d7fa75d4a
Fix #9568: autosummary: summarise overlined sectioned headings correctly 
Add an extra step in the autosummary summariser algorithm to get a valid
text form of section headings.  This fixed issues when the first element
of a summarised document was a section heading with overlines, such as

    =======
    Heading
    =======

Previously, the first line would be taken verbatim, which caused parse
errors in the rest of the document.
 2021-08-20 17:05:58 +01:00
Pawel Budzynski
f12f5bc075 add tests 2021-04-29 14:48:56 +02:00
Takeshi KOMIYA
6e438af6c0 test: Update testcase for docutils-0.17 (empty language) 
Since v0.17, docutils starts to load language module on parsing reST
document using StateMachine directly.  So far, our testcase uses invalid
language code for testing autosummary.  This fixes it to work with new
docutils.
 2021-04-03 23:54:19 +09: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
54e8b8d9bc refactor: test: Use rollback_sysmodules fixture in test_ext_autosummary 2020-12-31 10:55:45 +09:00
Takeshi KOMIYA
c86e92cb95 Fix #8306: autosummary: mocked modules are documented as empty page 
The :recursive: option for autosummary directive creates an empty page
for mocked modules unexpectedly.  This make them ignored.
 2020-12-27 21:45:15 +09:00
Takeshi KOMIYA
65ca7aa0c9 Fix #8501: autosummary: summary extraction splits text after "el at." 
Add "el at." to the list of abbreviations.
 2020-11-28 11:41:06 +09: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
92e863fb24 Close #8011: autosummary: Support instance attributes 
This allows the autosummary directive to take instance attributes to
build documents for them.
 2020-08-01 19:19:18 +09:00
Takeshi KOMIYA
da174138af
Merge pull request #7927 from jnothman/name-case-clash 
Add autosummary_filename_map config to avoid clashes
 2020-07-24 01:07:19 +09:00
Takeshi KOMIYA
68c732e97c autosummary: Add testcase for module constants (refs: #7469) 2020-07-17 01:15:28 +09:00
Joel Nothman
aae8ce8efa Fix toctree generation 2020-07-15 18:46:51 +10:00
Joel Nothman
52c173bdb9 Responding to comments 2020-07-10 11:30:06 +10:00
Joel Nothman
4e0ff5cac2 Fix attempt with new test root 2020-07-08 22:36:40 +10:00
Joel Nothman
72ca2bdffc Add autosummary_filename_map config to avoid clashes 2020-07-08 16:51:57 +10:00
Takeshi KOMIYA
c4f0d70d17
Merge branch '3.x' into 7865_extract_abbr 2020-06-29 02:04:40 +09:00
Takeshi KOMIYA
2d69b4211a Fix #7865: autosummary: Failed to extract summary line when abbr. found 2020-06-27 23:33:43 +09:00
Takeshi KOMIYA
4fa596ba4c Fix #7866: autosummary: Failed to extract correct summary line 
A hyperlink target in the docstring causes a system_error because
node_ids are cached expectedly during extracting a summary.
 2020-06-27 23:20:59 +09:00
Eric Wieser
d229b120ad Fix autoclass signature parsing 
This fixes:
* Signatures defined by __new__
* Signatures defined by metaclasses
* Signatures defined by builtin base classes

All of these changes bring the sphinx docs inline with the behavior of `inspect.signature`.

Note that this changes autodoc to output `.. py:class: MyClass()` with parentheses even if no user-defined __init__ is present.
This is quite deliberate, as if no user-defined `__init__` is present the default is `object.__init__`, which indeed does not take arguments.
 2020-05-28 08:36:56 +01:00
Takeshi KOMIYA
784d4cb36a Fix #7685: autosummary: imported members are listed unexpectedly 2020-05-21 01:24:46 +09:00
Daniel Fremont
de4aca857c revisions per comments from tk0miya 2020-05-17 09:07:11 -07:00
Álvaro Mondéjar
02d5cd439f Update 'test_autosummary_generate' test. 2020-05-14 19:16:45 +02:00
Álvaro Mondéjar
1dcfc44ace Fix automsummary directive wrong processing for invalid modules. 2020-05-14 17:06:12 +02:00
Takeshi KOMIYA
c4d4ba2835 Fix #7551: autosummary: a nested class is indexed as non-nested class 2020-05-07 01:57:46 +09:00
Takeshi KOMIYA
5bf997c55a refactor: Do not pass deprecated parameter in testcase 2020-05-03 23:41:54 +09:00
Takeshi KOMIYA
0bf9011509 Fix #7570: autosummary: template option is broken 2020-04-30 00:14:59 +09:00
Takeshi KOMIYA
037fe96dc1 Close #4030: autosummary: Add autosummary_context 2020-04-25 11:15:43 +09:00
Takeshi KOMIYA
ab3795f176 Fix #7536: sphinx-autogen: crashes when template uses i18n feature 2020-04-23 21:46:32 +09:00
Takeshi KOMIYA
72c57ff131 test: Fix flake8 violation 2020-04-22 01:29:48 +09:00
Takeshi KOMIYA
4a7934ba1a autosummary: Make recursively generated stub-files flatten 2020-04-22 00:27:59 +09:00
Takeshi KOMIYA
cc6ba63f5e test: Remove meaningless testcases 2020-04-22 00:23:37 +09:00
Takeshi KOMIYA
ef1362886f refactor: Not to use deprecated helper: Path.text() 2020-04-21 23:39:51 +09:00
Takeshi KOMIYA
7671bcc23b Remove autosummary_recursive configuration 
Now autosummary directive has :recursive: option to enable the
recursive feature individually.  So the configuration is no longer
needed.
 2020-04-21 23:38:18 +09:00
Takeshi KOMIYA
b9da9237bc Merge branch '3.x' into 6040_autosummary_recursive 2020-04-21 23:04:38 +09:00
Takeshi KOMIYA
476b73b6ca autosummary: Add :recursive: option to autosummary directive 2020-04-21 22:47:00 +09:00
Takeshi KOMIYA
dc46897768 Close #7490: autosummary: Add `:caption:` option to autosummary directive 2020-04-16 23:04:57 +09:00
Takeshi KOMIYA
4352991338 refactor: autosummary: Define AutosummaryEntry as a return type of find_autosummary_*() 2020-03-16 10:41:37 +09:00
Takeshi KOMIYA
665458561f fix 2020-02-23 01:41:31 +09:00
Takeshi KOMIYA
bdd08b1516 test: encoding="utf-8" is no longer needed on reading text 2020-02-01 12:25:49 +09:00
Takeshi KOMIYA
4dd8b1022f test: Use read_text() and read_bytes() 2020-02-01 11:58:51 +09:00
Takeshi KOMIYA
0319faf8f1 Merge branch '2.0' 2020-01-01 14:40:39 +09:00
Takeshi KOMIYA
eaf495c3c4 A happy new year! 2020-01-01 14:27:43 +09:00
Takeshi KOMIYA
15c266c445 Merge branch '2.0' 2019-11-30 21:52:42 +09:00
Takeshi KOMIYA
491b19d6bb autosummary: Allows to document a member forcedly if skip-member handler returns False 2019-11-16 18:19:33 +09:00
Takeshi KOMIYA
66c3dd3adb Close #6798: autosummary: emit `autodoc-skip-member` event on generating stub file 2019-11-16 18:19:31 +09:00
woutdenolf
11d9a97a34 refactor autosummary recursion tests 2019-07-08 09:06:52 +02:00
woutdenolf
9dc9b8754d Merge with master and address code review 2019-07-08 08:29:23 +02:00
Takeshi KOMIYA
4af90fcf75 Fix #247: autosummary: Add autosummary_generate_option to overwrite old stub file 2019-07-07 16:18:49 +09:00
Takeshi KOMIYA
95723aa6f6 Fix flake8 violations 2019-07-01 00:28:30 +09:00