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
19,025 Commits 2 Branches 219 Tags 163 MiB
fd42063725
Commit Graph

94 Commits

Author SHA1 Message Date
Adam Turner
5775912455 Collapse single line docstrings 2022-02-20 03:13:45 +00:00
Adam Turner
6bb7b891a1 Remove copyright and licence fields 2022-02-20 03:06:23 +00:00
Adam Turner
5694e0ce60 Fix module docstring indentation 2022-02-20 00:35:13 +00:00
Adam Turner
4f5a3269a6 Fix module docstring first line 2022-02-20 00:11:08 +00:00
Adam Turner
6b8bccec59 Remove module titles in docstrings 2022-02-19 23:17:29 +00:00
Jakob Lykke Andersen
ccc4f95b42 intersphinx role, hax role name to preserve case 2022-01-16 09:48:06 +01:00
Jakob Lykke Andersen
029d0e5b18 intersphinx role: new inventory parsing from role name 2022-01-16 09:48:06 +01:00
Jakob Lykke Andersen
ce5512e3af intersphinx role, implement warning scheme 
and temporarily remove explicit inventories
 2022-01-16 09:48:06 +01:00
Jakob Lykke Andersen
36c6eafdf1 intersphinx: explicitly parse out inventory specification 2022-01-16 09:48:06 +01:00
Jakob Lykke Andersen
8605644e83 intersphinx: more role testing 2022-01-16 09:47:54 +01:00
Takeshi KOMIYA
35dcc60a7c intersphinx: Add :intersphinx:***: role 2022-01-16 09:47:53 +01:00
Takeshi KOMIYA
b84771dcd2 A happy new year! 2022-01-01 18:45:03 +09:00
Jakob Lykke Andersen
56002be5e1 rename intersphinx_disabled_{refs -> reftypes} 
And change format for domains to {name}:*
 2021-10-31 13:56:26 +01:00
Jakob Lykke Andersen
cfbac2ceaa intersphinx_disabled_refs, rename 'all' to '*' 2021-10-31 13:23:23 +01:00
Jakob Lykke Andersen
0d9f4cd469 Generalize to disable specific refs as well. 2021-10-31 13:15:47 +01:00
Jakob Lykke Andersen
f22faa7e06 Add intersphinx_disabled_domains 
Fixes sphinx-doc/sphinx#2068
Replaces sphinx-doc/sphinx#8981
 2021-10-31 13:15:47 +01:00
Jakob Lykke Andersen
961f5af096 Intersphinx, refactoring 
Also, when a reference is unresolved, don't strip the inventory prefix.
 2021-10-31 13:15:46 +01:00
Takeshi KOMIYA
e6d3adf5d9 intersphinx: Add testcase for case insensitive term match (refs: #9299) 2021-07-11 19:33:38 +09:00
Takeshi KOMIYA
5a8dec457a refactor: reduce calls of find_pending_xref_conditions (refs: #9240) 
After #9246, `find_pending_xref_conditions()` should be only called from
intended modules.  At present, the Python Domain is the only module to
call it intendedly.  Therefore, this removes the needless calls of the
utility function from "unintended" modules.
 2021-05-22 15:34:30 +09:00
Jakob Lykke Andersen
87414faa92 Decl styling, fix cpp tests 2021-04-12 19:07:51 +02:00
Jakob Lykke Andersen
14f7d243bd Decl styling, more nodes and C++ conversion 2021-04-12 19:05:58 +02:00
Takeshi KOMIYA
7f0b13af6e intersphinx: Support pending_xref_condition 2021-03-06 14:58:15 +09:00
Takeshi KOMIYA
af6ed52ca1
Merge branch '3.x' into 8446_escape_spaces_inside_desc_signatures 2021-02-01 01:24:02 +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
c941406415 refactor with pyupgrade 
Run `pyupgrade --py3-only --keep-percent-format` to refine our code.

Note:  --keep-percent-format is required to keep translations available.
 2020-11-25 01:55:30 +09:00
Takeshi KOMIYA
96fe4c110c Fix #8446: html: consecutive spaces are displayed as single space 
In HTML, consecutive spaces are considered as single space by HTML
browsers.  To represent them as is, we have to escape them on rendering
them into HTML.  This starts to escape the whole of desc_signature node.
 2020-11-22 23:12:04 +09:00
François Freitag
419e145e36
Make tests/ a Python package 
Allows relative imports.
 2020-11-20 19:43:02 +01:00
Takeshi KOMIYA
21a3bd4127 refactor: Fix flake8 violations under tests/ directory 2020-11-15 17:15:40 +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
François Freitag
0178437f3c
Rewrite test_inspect_main_url to avoid mocking 
Makes the test more realistic by issuing an HTTP request.
Reduces coupling between test and the code under test.

The `http_server` helper was factored out into a new tests.utils module.
 2020-11-08 22:30:49 +01:00
Takeshi KOMIYA
754d04f80d Merge branch '2.4.x' into 3.x 2020-02-22 19:22:31 +09:00
Takeshi KOMIYA
2db006a0af Fix #7183: intersphinx: `:attr:` reference to property is broken 2020-02-22 01:28:13 +09:00
Takeshi KOMIYA
4dd8b1022f test: Use read_text() and read_bytes() 2020-02-01 11:58:51 +09:00
Takeshi KOMIYA
eaf495c3c4 A happy new year! 2020-01-01 14:27:43 +09:00
Takeshi KOMIYA
c83f2a0272 Fix #6140: Use unittest.mock instead of mock 2019-03-08 00:27:45 +09:00
Takeshi KOMIYA
76e9f57c2e Merge branch '1.8' 2019-01-02 16:16:25 +09:00
Takeshi KOMIYA
1b1ebd2c75 A happy new year! 2019-01-02 16:00:30 +09:00
Takeshi KOMIYA
556f599e6e intersphinx: Normalize mapping on config-inited 2018-12-17 22:03:47 +09:00
Jon Dufresne
bade33c7e4 Remove unnecessary encoding cookie from Python source files 
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.
 2018-12-16 12:22:12 -08:00
Jon Dufresne
5bf25eb445 Avoid respecifying default encoding for .encode()/.decode() calls 
In Python 3, both .encode() and .decode() default the encoding to
'utf-8'. See the docs:

https://docs.python.org/3/library/stdtypes.html#str.encode
https://docs.python.org/3/library/stdtypes.html#bytes.decode

Simplify and shorten the code by using the default instead of
respecifying it.
 2018-12-15 17:19:56 -08:00
Takeshi KOMIYA
cd08a6503c Fix #4664: Reading objects.inv fails again 2018-02-23 10:44:11 +09:00
Takeshi KOMIYA
f7027049b1 Fix flake8 violations 2018-02-19 23:20:56 +09:00
Takeshi KOMIYA
39d4584248 Merge branch 'stable' into 1.7-release 2018-02-03 02:14:06 +09:00
Takeshi KOMIYA
43ee8d194d intersphinx: Add testcase for inventory fallbacks 2018-01-31 01:22:33 +09:00
Takeshi KOMIYA
aa47e9decc Fix #4209: intersphinx: In link title, "v" should be optional if target has no version 2018-01-30 00:14:53 +09:00
Takeshi KOMIYA
4d040abafb Fix #4079: Add notranslate class to let Google Translate know they are not translatable 2018-01-13 20:25:49 +09:00
Takeshi KOMIYA
e18c49ec59 Merge commit '4277eb13315d5649401190df86874b3832ddfa3e' 2018-01-07 01:13:32 +09:00
Takeshi KOMIYA
850e9a9c5c Fix links to external option docs with intersphinx (refs: #3769) 2018-01-02 01:01:29 +09:00
Takeshi KOMIYA
f1f6ca8cc9 Merge branch 'happy_new_year' into master 2018-01-01 01:09:17 +09:00
Takeshi KOMIYA
2426cedb8b A happy new year! 2018-01-01 01:06:58 +09:00