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
15,920 Commits 2 Branches 219 Tags 163 MiB
569c7b02de
Commit Graph

15920 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Dominic Davis-Foster
2b646082d7 Fix typo'd comment in SphinxComponentRegistry.add_html_math_renderer() 2020-08-25 13:49:12 +01:00
Dominic Davis-Foster
05ad7e8020 Fix typo in warning emitted from Sphinx.add_lexer() 2020-08-25 13:48:17 +01:00
Kai Welke
6b87b8030c
Fix comment end string in LaTeXRenderer 
Fix bug introduced by commit 5f82825e27 in `self.env.comment_end_string`
 2020-08-23 09:29:56 +02:00
Gaurav Lalchandani
4313060c8a Fixes #8146: When identifying bases, only use classes from builtins 
In inheritance_diagram extension, while iterating over bases,
we verify if the base class is one of the Python built-in
class or not.
As of now, we simply check for its presence in all `builtins`
objects. Please note, `builtins` not only has built-in classes,
but also functions (like `open`) and other built-in objects.

To avoid any sort of future problem, it seems better to only
use classes (and of course exception classes).
 2020-08-22 20:00:41 +05:30
Juan Carrano
740be7f2a5 autodoc: blacklist typing.Generic.__new__ 
When documenting classes derived from typing.Generic (essentially all classes in the
typing module) the constructor signature would show an unhelpful (*args, **kwds).

typing.Generic has a __new__ method which was picked up by sphinx. With this patch it
is skipped and constructor signatures for generic classes are shown as they should.
 2020-08-21 18:47:50 +02:00
Juan Carrano
642686159f autodoc: Test the signature of typing.Generic subclasses. 
This test is currently failing because typing.Generic.__new__ clobbers the
real signature.
 2020-08-21 18:47:14 +02:00
Takeshi KOMIYA
e0b2162a77 Fix #8143: AttributeError if autodoc_default_options contains False 
autodoc crahses when autodoc_default_options contains False value
unexpectedly.  After this change, it also accepts False.
 2020-08-22 00:50:29 +09:00
Takeshi KOMIYA
ae9f0dd299
Merge pull request #8140 from chrisjsewell/docs/execution-process 
📚 DOCS: Improve build process overview
 2020-08-22 00:21:26 +09:00
Chris Sewell
46177f6af3 Correct numbers 2020-08-21 01:58:28 +01:00
Chris Sewell
5c744d8342 📚 DOCS: Improve build process overview 2020-08-20 22:37:37 +01:00
Takeshi KOMIYA
9d48cb9798
Merge pull request #8130 from yves-chevallier/stackoverflow 
Stackoverflow
 2020-08-16 11:46:40 +09:00
Yves Chevallier
e45f55d32f Add rubric in Getting help 2020-08-15 13:34:57 +02:00
Yves Chevallier
19f6c39c48 Invite users to ask their questions on Stackoverflow 2020-08-15 13:13:14 +02:00
Takeshi KOMIYA
f861b4cd1a Merge branch '3.2.x' into 3.x 2020-08-14 19:58:25 +09:00
Takeshi KOMIYA
d3af1cde2b Merge tag 'v3.2.1' into 3.x 2020-08-14 19:57:09 +09:00
Takeshi KOMIYA
fabe685638 Bump version 2020-08-14 19:55:41 +09:00
Takeshi KOMIYA
3597942810 Bump to 3.2.1 final 2020-08-14 19:53:48 +09:00
Takeshi KOMIYA
5d70682dda
Merge pull request #8108 from tk0miya/8099_NameError_for_TYPE_CHECKING 
Fix #8099: autodoc: NameError is raised when script uses TYPE_CHECKING
 2020-08-14 14:56:00 +09:00
Takeshi KOMIYA
d391212101
Merge branch '3.2.x' into 8099_NameError_for_TYPE_CHECKING 2020-08-14 14:37:19 +09:00
Takeshi KOMIYA
b2d524d2b2 Merge branch '3.2.x' into 3.x 2020-08-14 14:24:11 +09:00
Takeshi KOMIYA
ec7e8aa5eb Update CHANGES for PR #8058 2020-08-14 14:23:03 +09:00
Takeshi KOMIYA
dab15e2857
Merge pull request #8058 from nijel/single-domain 
i18n: Add support for having single text domain
 2020-08-14 14:21:43 +09:00
Jakob Lykke Andersen
90e9b31a16
Merge pull request #8117 from jakobandersen/c_cpp_function_attributes 
C and C++, parsing function attributes
 2020-08-13 19:45:52 +02:00
Jakob Lykke Andersen
52140be6b8 C and C++, parsing function attributes 
Fixes sphinx-doc/sphinx#8114
 2020-08-13 18:39:28 +02:00
Takeshi KOMIYA
5f420a4d8f
Merge pull request #8090 from tk0miya/remove_pylint 
Remove pylint task
 2020-08-14 01:29:01 +09:00
Takeshi KOMIYA
823bc30303
Merge pull request #8116 from harupy/color-pytest-output-log 
Color pytest output log
 2020-08-14 01:28:38 +09:00
harupy
2a632598c3 fix 2020-08-14 00:48:41 +09:00
harupy
2f971a61f3 Color pytest output log 2020-08-14 00:41:17 +09:00
Jakob Lykke Andersen
667a188e25
Merge pull request #8113 from jakobandersen/cpp_template_template 
C++, fix template template parameter parsing
 2020-08-13 17:29:18 +02:00
Jakob Lykke Andersen
d72fedb69d C++, fix template template parameter parsing 
https://github.com/sphinx-doc/sphinx/pull/8037#issuecomment-673511490
 2020-08-13 17:08:39 +02:00
Takeshi KOMIYA
1bca9f9587 Close #8100: html: Show a better error message for html_static_files 
The HTML Builder crashes if error raised on copying html_static_files.
This handles the exception and show a better error message to let users
the reason of errors (ex. failed on extracting Jinja templates).
 2020-08-14 00:07:01 +09:00
Takeshi KOMIYA
088b049170 Fix #8103: autodoc: cached_property is not considered as a property 
sphinx.util.inspect:isproperty() does not considers that
cached_property decorator that has been added since Python 3.8 is
a kind of properties.  This fixes it.
 2020-08-13 23:16:59 +09:00
Takeshi KOMIYA
611fff975e Fix #8099: autodoc: NameError is raised when script uses TYPE_CHECKING 
`typing.get_type_hints()` raises NameError when the target object
contains unresolavable type annotation (ex. TYPE_CHECKING).  This
handles the exception and use unresolved annotations for type hints.
 2020-08-13 22:57:12 +09:00
Takeshi KOMIYA
99e36398fc Update CHANGES for PR #8095 2020-08-13 22:38:57 +09:00
Takeshi KOMIYA
6e62d33566
Merge pull request #8095 from keewis/toggle-preprocessor 
add a setting to enable / disable the numpy type preprocessor
 2020-08-13 22:35:36 +09:00
Keewis
1c388241b4 default to False and update the tests 2020-08-12 19:48:07 +02:00
Takeshi KOMIYA
4baa7ce99b Update CHANGES for PR #8102 2020-08-13 01:53:30 +09:00
Takeshi KOMIYA
22820d841e
Merge pull request #8102 from yves-chevallier/location 
Use current node location in case of error (related to #8093)
 2020-08-13 01:50:59 +09:00
Takeshi KOMIYA
e70a30e5a3
Merge pull request #8092 from tk0miya/8085_AttributeError_on_get_type_hints 
Fix #8091: autodoc: AttributeError is raised on documenting an attribute
 2020-08-12 23:31:53 +09:00
Yves Chevallier
53a82a5630 Use node as location 2020-08-12 16:29:26 +02:00
Keewis
be65bded76 fix a typo 2020-08-10 23:10:27 +02:00
Keewis
27c252ccba only preprocess if the preprocessor is enabled 2020-08-10 13:04:21 +02:00
Keewis
2d180e49c2 add a setting to disable the type preprocessor 2020-08-10 13:03:50 +02:00
Takeshi KOMIYA
bb09f92154 Fix #8091: autodoc: AttributeError is raised on documenting an attribute 
Until Python 3.5.2, typing.get_type_hints() raises AttributeError if
given object does not have `__code__` attribute.  This handles the
exception not to crash building documents.

Note: The AttributeError was fixed at 3.5.3
refs: 991d14fee1
 2020-08-10 16:24:13 +09:00
Takeshi KOMIYA
bf26080042 Merge branch '8084_KeyError_for_broken_class' into 3.2.x 2020-08-10 16:06:28 +09:00
Takeshi KOMIYA
38b868cc0d
Merge pull request #8085 from tk0miya/8084_KeyError_for_broken_class 
Fix #8084: autodoc: KeyError is raised on documenting a broken attribute
 2020-08-10 14:46:33 +09:00
Takeshi KOMIYA
24f690c9e5
Merge branch '3.x' into 8084_KeyError_for_broken_class 2020-08-10 14:23:49 +09:00
Takeshi KOMIYA
6cf1301c9e Remove pylint task 
At present, pylint has no longer been used in this project. This
removes the tasks and files for pylint from repository.
 2020-08-10 13:20:06 +09:00
Takeshi KOMIYA
e4a55cb76f
Merge pull request #8080 from yves-chevallier/check-latex-packages 
[Feature] Check if LaTeX package already added
 2020-08-09 23:49:02 +09:00
Takeshi KOMIYA
f7431b927c Fix #8084: autodoc: KeyError is raised on documenting a broken attribute 
``typing.get_type_hints()`` raises KeyError when a class having invalid
__module__ was given.  This handles the exception not to crash on build
documents.
 2020-08-09 23:43:01 +09:00