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,681 Commits 2 Branches 219 Tags 163 MiB
3ff956c27a
Commit Graph

15681 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Keewis
8feb5f9ac9 mention that the type aliases only work with napoleon_use_param 2020-07-25 11:38:10 +02:00
Keewis
530793d997 update the link to the official docstring guide 2020-07-25 11:37:32 +02:00
Keewis
920048466c don't provide a empty line number 2020-07-25 11:22:29 +02:00
Takeshi KOMIYA
5b096c42ff
Merge pull request #8002 from tk0miya/update_doc_linter 
doclinter: Allow a very long literal string
 2020-07-24 23:26:38 +09:00
Takeshi KOMIYA
0c4edbdb38 doclinter: Allow a very long literal string 2020-07-24 23:09:56 +09:00
Takeshi KOMIYA
95067c0813
Merge pull request #8001 from tk0miya/5090_distutils_version 
BuildDoc: link verbosity to distutils'
 2020-07-24 14:01:10 +09:00
Takeshi KOMIYA
0b57727233 Update CHANGES for PR #5090 2020-07-24 13:36:49 +09:00
Takeshi KOMIYA
d177956365 Fix a mypy violation 2020-07-24 13:36:49 +09:00
Takeshi KOMIYA
c780492a4f Merge branch '3.x' into 5090_distutils_version 2020-07-24 13:33:35 +09:00
Takeshi KOMIYA
875346307f linkcheck: Fix a protocol relative URL is considered as a local file 
Since #7985, a protocol relative URL (URL starts with "//") is considered
as a local file incorrectly.  This makes it to a "unchecked" URL.

refs: #7985
 2020-07-24 02:13:23 +09:00
Takeshi KOMIYA
3d0818f1cb Update CHANGES for PR #7927 2020-07-24 01:23:08 +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
Fabio Utzig
15d93d2c76 domains: c: add support for named variadic argument 
Add support for gcc extensions which allow variadic arguments to be
named: https://gcc.gnu.org/onlinedocs/cpp/Variadic-Macros.html

A named variadic argument takes the form "<name>..." with spaces around
allowed and must be the last argument.

Currently it generates a warning "Invalid C declaration: Expected
identifier, ')', or ',' in macro parameter list."

Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
 2020-07-23 12:32:30 -03:00
Joel Nothman
144f18a528 Remove irrelevant test RST 2020-07-23 17:27:57 +10:00
Joris Beckers
4512d2757b Allow searching for things like serials, phone numbers, etc 2020-07-22 12:00:46 +02:00
Keewis
ae35f81d3d allow mapping to a long name 2020-07-21 17:13:41 +02:00
Keewis
9b425606e7 support pandas-style default spec by postprocessing tokens 2020-07-21 12:26:28 +02:00
Takeshi KOMIYA
d8064a8b8f
Merge pull request #7985 from tk0miya/5208_linkcheck_for_localfiles 
Close #5208: linkcheck: Support checks for local links
 2020-07-21 01:37:04 +09:00
Takeshi KOMIYA
d4863a80c0
Merge pull request #7984 from tk0miya/7983_Generator_annotation 
Fix #7983: autodoc: Generator type annotation is wrongly rendered in py36
 2020-07-20 01:00:04 +09:00
Takeshi KOMIYA
f95ba21f4a Close #5208: linkcheck: Support checks for local links 2020-07-19 19:08:14 +09:00
Takeshi KOMIYA
f30284ef92
Merge pull request #7966 from tk0miya/7469_additional_testcase 
autosummary: Add testcase for module constants (refs: #7469)
 2020-07-19 16:43:01 +09:00
Takeshi KOMIYA
b6bf2b88ce refactor: pycode: Use OrderedDict to store variable comments 
It is worthy to keep the order of analyzer.attr_docs to generate
document in reproducible. So this uses OrderedDict explicitly to do
that. It also helps python3.5 environment.
 2020-07-19 16:00:52 +09:00
Takeshi KOMIYA
b3b7cbbd38 Fix #7983: autodoc: Generator type annotation is wrongly rendered in py36 
This adds a special handler (if-branch) for Generator type to stringify
them correctly.  So far, they have been considered as a kind of Callable.
 2020-07-19 15:48:07 +09:00
Takeshi KOMIYA
5850d6b8f9
Merge pull request #7982 from tk0miya/7840_optimize_bootstrap 
Close #7840: i18n: Optimize the dependencies check on bootstrap
 2020-07-19 15:11:12 +09:00
Takeshi KOMIYA
f65ef0e623
Merge pull request #7975 from tk0miya/2050_2nd_symbol_section 
Fix #2050: Symbols sections are appeared twice in the index page
 2020-07-19 15:10:50 +09:00
Takeshi KOMIYA
a111b9aba9
Merge pull request #7957 from tk0miya/4888_keep_refexplicit 
Fix #4888: i18n: Failed to add an explicit title to ``:ref:`` role
 2020-07-19 15:08:51 +09:00
Takeshi KOMIYA
35e1623338 Fix #4888: i18n: Failed to add an explicit title to `:ref:` role 
To allow to give (or not to give) an explicit title to the
pending_xref nodes on translation, this skips to override the
attribute on merge original and translated documents.
 2020-07-19 15:00:38 +09:00
Takeshi KOMIYA
69fc1953c6 Close #7840: i18n: Optimize the dependencies check on bootstrap 
Replace a nested-loop comparison by hash-search to improve the
performance of dependencies checks on bootstrap.
 2020-07-19 14:30:18 +09:00
Takeshi KOMIYA
80c981e2c0
Merge pull request #7980 from tkoyama010/patch-1 
fix typo
 2020-07-19 14:15:16 +09:00
Tetsuo Koyama
f1ae803666
⬆️ sphinx/search/ru.py 2020-07-19 13:52:00 +09:00
Tetsuo Koyama
3da3ced13d
⬆️ sphinx/search/da.py 2020-07-19 13:51:47 +09:00
Tetsuo Koyama
ae7c4cc3b8 fix typo 2020-07-19 00:43:11 +00:00
Takeshi KOMIYA
aa57899366
Merge pull request #5405 from tk0miya/4611_run_epubcheck 
Run epubcheck on CI
 2020-07-19 01:25:09 +09:00
Takeshi KOMIYA
081dcd23c1 test: Remove search link from test-root 
To make EPUB output valid, remove a search link from test-root.
 2020-07-18 16:57:51 +09:00
Takeshi KOMIYA
a3cfdffa9b Run epubcheck on Circle CI 2020-07-18 16:57:29 +09:00
Takeshi KOMIYA
00e4a9e5b5
Merge pull request #7977 from tk0miya/refactor_testcase_for_toctree_self 
Move "self" toctree testcase to test-toctree
 2020-07-18 16:56:50 +09:00
Takeshi KOMIYA
4ab487350a
Merge pull request #7976 from tk0miya/test_build_epub_decode 
test: Decode stdout and stderr of epubcheck
 2020-07-18 16:46:06 +09:00
Takeshi KOMIYA
4bfdd804c2 Move "self" toctree testcase to test-toctree 
To be epubcheck clean, remove "self" toctree from root case.
 2020-07-18 16:42:23 +09:00
Takeshi KOMIYA
000328f7fd test: Decode stdout and stderr of epubcheck 2020-07-18 16:38:22 +09:00
Takeshi KOMIYA
66da266441 Fix #2050: Symbols sections are appeared twice in the index page 
Multibyte symbols are categorized to independent symbols section
different to single byte symbols.  This integrate them to a single
section.
 2020-07-18 15:52:57 +09:00
Takeshi KOMIYA
4ec6cbe341 Update CHANGES for PR #7969 2020-07-18 12:47:36 +09:00
Takeshi KOMIYA
689ba0a257
Merge pull request #7969 from multun/i18n-math-block 
Fix #7968: i18n: process math_block as a literal node
 2020-07-18 12:45:27 +09:00
Takeshi KOMIYA
79d50b5a71
Merge pull request #7947 from tk0miya/1362_private_class_attributes 
Fix #1362: autodoc: Support private class attributes
 2020-07-18 12:07:03 +09:00
Takeshi KOMIYA
488a173904 Fix #1362: autodoc: Support private class attributes 
So far, autodoc treats a "private" class attribute as a mere attribute.
But its name is mangled by python interpreter. This make it unmangled
name to be documented expectedly.
 2020-07-18 03:39:38 +09:00
Takeshi KOMIYA
e5d9527b0b
Merge pull request #7971 from mattdocumatt/patch-1 
Add Tech writer at work blog
 2020-07-17 20:46:17 +09:00
Matt from Documatt
2b091c32e5
Add Tech writer at work blog 
Adding my blog about tech writing with Sphinx. Built with Sphinx and custom theme.
 2020-07-17 10:34:38 +02:00
Victor "multun" Collod
602105826a i18n: process math_block as a literal node 2020-07-16 20:08:49 -07:00
Jakob Lykke Andersen
c2df631178
Merge pull request #7967 from jakobandersen/c_optimization 
Speed up the C domain a bit
 2020-07-16 20:27:41 +02:00
Jakob Lykke Andersen
b58affe91b C, remove redundant code in clear_doc 2020-07-16 20:01:32 +02:00
Jakob Lykke Andersen
79cd37d81c C, speed up identifier comparison 2020-07-16 20:01:32 +02:00