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,117 Commits 2 Branches 219 Tags 163 MiB
a4ccca76ec
Commit Graph

16117 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Grant Likely
add70354f1 Fix 'oneside' latex output 
Sphinx.sty had an FIXME bug where documents with the 'oneside' option
would output lots of the following warnings when building the document:

   Package Fancyhdr Warning: \fancyfoot's `E' option without twoside
   option is useless on input line 309.

Fix the problem by using \if@twoside around the offending tex code that
tries to set format for the even pages. 'Even' pages don't exist on
oneside builds, which causes the warning to be emitted.

Fixes: #8215
 2020-09-16 14:48:53 +01:00
Jakob Lykke Andersen
008d0201e1
Merge pull request #8207 from jakobandersen/c_alias_recursive 
C, recursive alias declarations
 2020-09-15 19:51:16 +02:00
Takeshi KOMIYA
000210e7c2
Merge pull request #8111 from tk0miya/8103_cached_property 
Fix #8103: autodoc: cached_property is not considered as a property
 2020-09-16 00:58:11 +09:00
Jakob Lykke Andersen
49e7400123 C, fix names in get_objects() 
Fixes sphinx-doc/sphinx#8160
 2020-09-14 21:16:15 +02:00
Jakob Lykke Andersen
500f45fd4c C, recursive alias declarations 
Fixes sphinx-doc/sphinx#8141
 2020-09-13 16:37:53 +02:00
Takeshi KOMIYA
564a577a4a Fix #8169: LaTeX: pxjahyper loaded even when latex_engine is not platex 2020-09-13 11:10:33 +09:00
Takeshi KOMIYA
dfbe687db6
Merge branch '3.x' into 8103_cached_property 2020-09-13 11:07:33 +09:00
Takeshi KOMIYA
1d0b424898
Merge pull request #8112 from tk0miya/8100_better_error_for_html_static_files 
Close #8100: html: Show a better error message for html_static_files
 2020-09-13 11:06:41 +09:00
Takeshi KOMIYA
0b44e68d4f Merge branch '3.2.x' into 3.x 2020-09-13 10:51:15 +09:00
Takeshi KOMIYA
b5dc3adf66
Merge pull request #8205 from tk0miya/test_with_pygments270 
Fix our test failed with pygments-2.7.0
 2020-09-13 10:50:50 +09:00
Takeshi KOMIYA
85b24a2e88 Fix our test failed with pygments-2.7.0 
Since pygments-2.7.0, it has changed the style of output HTML.
That makes our test broken.  This fixes it to pass with new pygments.
 2020-09-13 10:42:07 +09:00
Takeshi KOMIYA
be714fa75b
Merge pull request #8177 from sphinx-doc/dependabot/npm_and_yarn/http-proxy-1.18.1 
Bump http-proxy from 1.17.0 to 1.18.1
 2020-09-13 01:42:26 +09:00
Takeshi KOMIYA
5b226b9c87
Merge pull request #8193 from tk0miya/8192_napoleon_removes_description 
Fix #8192: napoleon: description is disappeared by inline literals
 2020-09-13 01:41:43 +09:00
Takeshi KOMIYA
c05c1320fa
Merge pull request #8174 from tk0miya/8163_update_warning 
Fix #8163: Update warning message for :dedent: option
 2020-09-13 01:41:03 +09:00
Jakob Lykke Andersen
59766c2351 Update CHANGES after PR 2020-09-12 14:33:57 +02:00
Jakob Lykke Andersen
46a6b0848b
Merge pull request #8188 from utzig/fix-c-domain-intersphinx 
domains: c: add missing intersphinx object types
 2020-09-12 14:32:01 +02:00
Takeshi KOMIYA
fd3d654c17 Fix #8190: autodoc: parse error for docstring w/o ending blank lines 
autodoc raises a parsing error if some extension generates a docstring
not having blank lines at the tail.  This appends a blank line if
generated one does not contain it.
 2020-09-12 16:04:41 +09:00
Takeshi KOMIYA
42bfed2cb3 Fix #8192: napoleon: description is disappeared by inline literals 
The napoloen wrongly parses a parameter definition because regexp
matches literal string by longest match unexpectedly.
 2020-09-10 22:34:38 +09:00
Fabio Utzig
8c4193027b domains: c: add missing intersphinx object types 
For intersphinx to be able to resolve references to C-Domain objects, it
needs to have them declared in the obj_types dict. This is currently
missing enum, enumerator, struct and union so those can't be referenced
by an external project. This commit fixes the issue by adding them.

Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
 2020-09-09 09:46:46 -03:00
Jakob Lykke Andersen
07374d95c1
Merge pull request #8187 from utzig/fix-typos 
domains: c: cpp: fix typos
 2020-09-09 14:24:27 +02:00
Fabio Utzig
8d882e4737 domains: c: cpp: fix typos 
Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
 2020-09-09 08:33:12 -03:00
Brecht Machiels
c9d8eac5ac Don't remove substitution_reference nodes (fix #7953) 
SubstitutionDefinitionsRemover is now a SphinxPostTransform, only
applied in the Sphinx builder, as was originally the case (see #4827).
 2020-09-08 17:34:02 +02:00
dependabot[bot]
1e5231d523
Bump http-proxy from 1.17.0 to 1.18.1 
Bumps [http-proxy](https://github.com/http-party/node-http-proxy) from 1.17.0 to 1.18.1.
- [Release notes](https://github.com/http-party/node-http-proxy/releases)
- [Changelog](https://github.com/http-party/node-http-proxy/blob/master/CHANGELOG.md)
- [Commits](https://github.com/http-party/node-http-proxy/compare/1.17.0...1.18.1)

Signed-off-by: dependabot[bot] <support@github.com>
 2020-09-06 01:30:34 +00:00
Takeshi KOMIYA
d78306c7f9 Fix #8163: Update warning message for :dedent: option 2020-09-05 18:52:59 +09:00
Takeshi KOMIYA
31f26a0bbf
Merge pull request #8171 from pdecat/patch-1 
Fix some broken links
 2020-09-04 02:49:02 +09:00
Patrick Decat
7a3170b77a Fix some broken links 2020-09-03 15:22:50 +02:00
Takeshi KOMIYA
adb81c510a
Merge pull request #8162 from faaxm/docs-fix-typo 
Fixes minor typo in quickstart.rst
 2020-09-02 23:26:41 +09:00
Falko Axmann
849ef212bc Fixes minor typo in quickstart.rst 2020-08-30 14:39:20 +02:00
Takeshi KOMIYA
a16cca27ef
Merge pull request #8144 from tk0miya/8143_autodoc_default_value_False 
Fix #8143: AttributeError if autodoc_default_options contains False
 2020-08-30 06:21:18 +09:00
Takeshi KOMIYA
03f2c7fc51
Merge pull request #8149 from kai687/patch-1 
Fix comment end string in LaTeXRenderer
 2020-08-30 06:20:40 +09:00
Takeshi KOMIYA
832c0c0621
Merge pull request #8153 from domdfcoding/fix-typos 
Fix typos
 2020-08-30 06:19:24 +09:00
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
Keewis
439f75afd2 enable preprocessing in the tests 2020-08-18 16:01:52 +02:00
Keewis
3c24021972 Merge branch '3.x' into preprocess-other-sections 2020-08-18 15:47:53 +02: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