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
17,090 Commits 2 Branches 219 Tags 163 MiB
4f7f3304b1
Commit Graph

17090 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Takeshi KOMIYA
790adf1f4a
Merge pull request #8739 from tk0miya/refactor_doc2 
doc: minor fix
 2021-01-24 14:08:39 +09:00
Takeshi KOMIYA
97f54bdf31
Merge pull request #8733 from tk0miya/update_underscore.js-1.12.0 
Update Underscore.js to 1.12.0
 2021-01-24 14:07:16 +09:00
Takeshi KOMIYA
ee5560b773
Merge pull request #8732 from tk0miya/refactor_documentation_options 
refactor: html theme: Insert documentation_options.js via script_files
 2021-01-24 14:00:13 +09:00
Takeshi KOMIYA
deda1918fc
Merge pull request #8731 from tk0miya/8004_preprocess_types_for_google 
Fix #8004: napoleon_preprocess_types for Google style docstrings
 2021-01-24 13:59:21 +09:00
Takeshi KOMIYA
2522b61185
Merge pull request #8729 from tk0miya/8727_namespace_subpackage 
Fix #8727: apidoc: namespace module file is not generated if no submodules
 2021-01-24 13:58:33 +09:00
jfbu
3a3a479f1e Improve Sphinx own pdf docs 
Prior to this the depth of the bookmarks is too low, one does not even
get to see for example what are the built-in extensions offered by
Sphinx.

Similarly the LaTeX created table of contents has not enough depth.
Dozens of contiguous pages from our documentation get only a single
link, it is very hard for newcomer to get some feeling of the scope of
Sphinx.  With a more detailed table of contents (be it inside the PDF or
via the collapsable bookmark panel of PDF viewer) learning Sphinx is
easier.
 2021-01-24 00:41:59 +01:00
Takeshi KOMIYA
a2d6ee6108 doc: Apply :params: to some APIs in app class 2021-01-24 01:11:04 +09:00
Takeshi KOMIYA
f873a5890f Fix #8054: Add explanation for types argument of add_config_value() 2021-01-24 00:44:20 +09:00
Takeshi KOMIYA
2626a74f0a doc: Show type annotations for methods of Sphinx application class 2021-01-24 00:08:04 +09:00
Takeshi KOMIYA
3100ceb220 doc: minor fix 2021-01-23 22:32:17 +09:00
Takeshi KOMIYA
f707cb30a1
Merge pull request #7798 from stefanodavid/code-block-crossref-doc 
documentation for proper code-block cross-referencing
 2021-01-23 22:31:02 +09:00
Takeshi KOMIYA
41924776c4 Fix #8118: doc: the default setting of today_fmt 
Sphinx has used `'%b %d, %Y'` as a default setting of today_fmt longer.
So this fixes our document as Sphinx does.
 2021-01-23 22:11:33 +09:00
Takeshi KOMIYA
2843fdfdea
Merge pull request #8736 from jfbu/latex_fix_8735 
Fix #8735
 2021-01-23 21:01:44 +09:00
Takeshi KOMIYA
c50ce99c9d refactor: Remove unused method 2021-01-23 20:51:02 +09:00
Takeshi KOMIYA
9d975b65bd Update CHANGES for PR #8510 2021-01-23 20:50:21 +09:00
Takeshi KOMIYA
7cfcd81b76 doc: html_favicon and html_logo accept URL now 2021-01-23 20:49:15 +09:00
Takeshi KOMIYA
76d0a0be82 Update CHANGES 2021-01-23 20:45:03 +09:00
Takeshi KOMIYA
ccf4ae3729 Merge branch 'master' into 8510_html_logo_url 2021-01-23 20:44:13 +09:00
Takeshi KOMIYA
65a69965a1 html theme: Add favicon_url and logo_url 
To embed the external favicon and logo image, this adds new template
variable `favicon_url` and `logo_url` that point the external URL or
relative path for the favicon/logo file from current file.  It helps to
use it on template files.
 2021-01-23 20:39:09 +09:00
jfbu
e63365f94e Fix #8735 
It is hard to provide a unit test, because the problem only raises a
LaTeX warning and shows as broken internal links in pdf output.

As the fix moves some LaTeX code to the end of preamble, user or
extension code may have to be moved there too.  However, a large part of
it already was delayed.  I checked that sphinxmessages.tex does not
introduce preamble code which would be broken from missing macros due
to this change.
 2021-01-23 11:21:29 +01:00
Takeshi KOMIYA
3f5fc6278c refactor: Add sphinx.util:isurl() 2021-01-23 18:39:27 +09:00
Steve Piercy
cef669cb0f Update the link to the new sphinx-contrib organization 
This should be backported to at least 3.x, too.
 2021-01-23 17:28:35 +09:00
Takeshi KOMIYA
37fc43a4d3
Merge pull request #8734 from stevepiercy/patch-2 
Update the link to the new sphinx-contrib organization
 2021-01-23 17:27:04 +09:00
Jean-François B
38c6143470
Merge pull request #8716 from jfbu/latex_font_for_pdflatex 
LaTeX: update default font configuration
 2021-01-23 09:22:18 +01:00
jfbu
2e22bd0a23 Merge branch 'master' into latex_font_for_pdflatex 2021-01-23 09:13:08 +01:00
Takeshi KOMIYA
85e49ab20f Update CHANGES for PR #8247 2021-01-23 17:10:12 +09:00
Takeshi KOMIYA
87e28af9e5
Merge pull request #8648 from tk0miya/refactor_abc 
refactor: some domain base classes become subclasses of abc.ABC
 2021-01-23 17:09:17 +09:00
Steve Piercy
bd63ae9950
Update the link to the new sphinx-contrib organization 
This should be backported to at least 3.x, too.
 2021-01-23 00:08:57 -08:00
Takeshi KOMIYA
af0dfa20d0
Merge pull request #8247 from silene/inter_prodlist_refs 
Allow production lists to refer to tokens from other production groups.
 2021-01-23 17:07:52 +09:00
Takeshi KOMIYA
05eb3c6054 refactor: Index class becomes subclasses of abc.ABC 
The `Index` class becomes subclasses of `abc.ABC` to indicate
methods that must be overrided in the concrete classes.
 2021-01-23 16:59:55 +09:00
Guillaume Melquiond
ffacb2ca18 Add testcase. 2021-01-23 08:57:36 +01:00
Takeshi KOMIYA
9a905ce547
Merge pull request #8724 from jfbu/latex_fancyboxissue 
Closes: #8339
 2021-01-23 16:47:21 +09:00
Takeshi KOMIYA
1b4265da4d Update Underscore.js to 1.12.0 2021-01-23 16:41:59 +09:00
Takeshi KOMIYA
a957d6f710 refactor: html theme: Insert documentation_options.js via script_files 2021-01-23 15:39:37 +09:00
Takeshi KOMIYA
440e64a91b Fix #8004: napoleon_preprocess_types for Google style docstrings 
Type definitions in Google style docstrings are rendered as references
when :confval:`napoleon_preprocess_types` enabled.
 2021-01-23 14:20:19 +09:00
jfbu
524473372a Remove unneeded CHANGES entry mentioning #8339 2021-01-22 20:34:53 +01:00
Takeshi KOMIYA
650f8ea237 Fix #8727: apidoc: namespace module file is not generated if no submodules 
sphinx-apidoc should generate a namespace module file when
`--implicit-namespace` option given.  This fixes the case the namespace
module has subpackages, but no submodules.
 2021-01-23 00:40:16 +09:00
Takeshi KOMIYA
5ce72f465b Merge branch '3.x' 2021-01-22 22:52:32 +09:00
Takeshi KOMIYA
a71028bf9e
Merge pull request #8719 from tk0miya/8714_kbd_capslock 
Fix #8714: html: kbd role with "Caps Lock" rendered incorrectly
 2021-01-22 22:07:06 +09:00
Takeshi KOMIYA
4dd4ff8736
Merge pull request #8726 from markus-oehme-pg40/patch-1 
doc: Link to detailed extension documentation
 2021-01-22 22:02:13 +09:00
Takeshi KOMIYA
d6f41227d7 Fix #8714: html: kbd role with "Caps Lock" rendered incorrectly 
`:kbd:` role has to support keys in consist of multiple words (ex. caps
lock, num lock, etc.)
 2021-01-22 21:58:19 +09:00
Takeshi KOMIYA
d5bc970dd9
Merge pull request #8707 from tk0miya/8704_viewcode_not_working 
Fix #8704: viewcode: anchors are generated in incremental build
 2021-01-22 21:54:25 +09:00
Takeshi KOMIYA
5260143afe Fix #8704: viewcode: anchors are generated in incremental build 
The anchors for viewcode was generated in the reading phase only if
supported builder is used.  It causes anchors are missing on the
incremental build after the build for non supported builder.

This introduces `viewcode_anchor` node to insert the anchor even if non
supported builders.  They will be converted to the anchor tag in the
resolving phase for supported builders.  Or, they will be removed for
non supported builders.
 2021-01-22 21:41:42 +09:00
Takeshi KOMIYA
d5d072bc3a Merge branch '3.4.x' into 3.x 2021-01-22 21:40:27 +09:00
Takeshi KOMIYA
aebfbbb532
Merge pull request #8728 from tk0miya/mypy-0.800 
Fix mypy violations (with mypy-0.800)
 2021-01-22 21:39:01 +09:00
Takeshi KOMIYA
1679a0916d Fix mypy violations (with mypy-0.800) 2021-01-22 21:26:58 +09:00
Takeshi KOMIYA
86c75cea13
Merge pull request #8721 from tk0miya/8720_viewcode_incremental_build 
Fix #8720: viewcode: module pages are generated for epub on incremental build
 2021-01-22 21:14:00 +09:00
Markus Oehme
eddce3019f ci: force empty commit to rerun ci. 2021-01-22 09:54:53 +01:00
markus-oehme-pg40
e59365923b
doc: Link to detailed extension documentation 
I missed that there are actually two sections explaining extensions in the docs and just saw the examples based one. This lead to me thinking "kind of lousy documentation, but that's probably par for the course". Would there have been a pointer to the detailed extension API description it would have saved me hours of guesswork.
 2021-01-22 09:29:19 +01:00
jfbu
11e7feb6fa Closes: #8339 
Handled as only a documentation issue.
 2021-01-21 19:51:59 +01:00