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,235 Commits 2 Branches 219 Tags
1254b8011347b309af122dbe91a9439cc56f4381
Commit Graph

2919 Commits

Author SHA1 Message Date
Takeshi KOMIYA
bbcd471557 Merge branch '3.x' 2020-11-09 02:50:08 +09:00
Takeshi KOMIYA
1955a08378 Merge branch '3.x' into 8105_incorrect_class_constructor 2020-11-08 12:34:09 +09:00
Takeshi KOMIYA
cad02e62e6 Fix #8375: URL of transifex project page 2020-11-05 23:52:59 +09:00
Takeshi KOMIYA
8bf84167a3 Merge branch '3.x' 2020-11-05 02:21:47 +09:00
Takeshi KOMIYA
6d05b1aeb3 Fix #8105: autodoc: the signature of decorated class is incorrect 
In #7651, autodoc stops to undecorate the functions on getting the
signature from the callables.  But some kinds of decorators conceals
the correct signature because they pass through their arguments via
`(*args, **kwargs)`.

This restarts to undecorate the functions again as before #7651.
 2020-11-05 01:57:40 +09:00
Takeshi KOMIYA
c028fb7a40 Merge pull request #8359 from sphinx-doc/8349_sphinx-contrib 
doc: Update sphinx-contrib repos' URL (refs: #8349)
 2020-11-03 11:29:31 +09:00
Takeshi KOMIYA
0e98e9b1a8 Fix #6914: Emit a detailed warning when failed to resolve :ref: 
To be clear the ambiguous warning for missing-reference :ref:,
this separates the warning to missing-label and missing-caption.

To emit a warning dynamically, this also adds a new event:
`warn-missing-reference` to customize warning messages via event
handlers.
 2020-11-03 02:27:43 +09:00
Takeshi KOMIYA
11edef1a26 doc: Update sphinx-contrib repos' URL (refs: #8349) 2020-11-03 02:13:05 +09:00
Takeshi KOMIYA
7eabbfc5ec Merge pull request #8284 from tk0miya/7996_man_make_section_directory_by_default 
Close #7996: manpage: Make a section directory on build manpage by default
 2020-10-28 11:03:13 +09:00
Takeshi KOMIYA
c40b4249cd Merge branch '3.x' into master 2020-10-28 02:23:36 +09:00
Takeshi KOMIYA
a843fd3db8 Close #7996: manpage: Make a section directory on build manpage by default 2020-10-28 02:15:36 +09:00
Takeshi KOMIYA
b453be75c9 Fix #8298: sphinx-quickstart: Add :option:sphinx-quickstart --no-sep option 2020-10-26 01:12:36 +09:00
Takeshi KOMIYA
f26569007b Merge pull request #8334 from mgeier/doc-favicon 
DOC: Add favicon
 2020-10-25 18:47:30 +09:00
Jon Dufresne
554bb5e9b9 Fix docs type: "the builder builders" → "builders" 2020-10-24 09:35:22 -07:00
Matthias Geier
84c6d693f4 DOC: Add favicon 2020-10-24 17:41:02 +02:00
Takeshi KOMIYA
3b85187ffa Merge pull request #8289 from graingert/allow-to-suppress-duplicated-toc 
Allow to suppress "duplicated toc entry" warnings from epub builder
 2020-10-24 20:29:06 +09:00
Takeshi KOMIYA
f1af7dc84f Merge pull request #8324 from pradyunsg/patch-1 
Documentation: Reword section on Third Party Themes
 2020-10-24 18:28:19 +09:00
Takeshi KOMIYA
445b9515c1 Merge branch '3.x' 2020-10-24 18:12:45 +09:00
Pradyun Gedam
18b2f2cdf2 Reword section on Third Party Themes 
- No longer attempt to be the location for listing themes -- only Sphinx-RTD-Theme was listed here.
- Mention the classifier used when searching on PyPI.
- Emphasize sphinx-themes.org as a gallery of themes.
 2020-10-21 11:16:59 +05:30
Thomas Grainger
3f26564c28 Apply suggestions from code review 2020-10-05 22:10:25 +01:00
Thomas Grainger
3eecf133d8 Fix #8289: Allow to suppress "duplicated ToC entry found" warnings from epub builder 2020-10-05 09:29:16 +01:00
François Freitag
bd49c3c2ef Outdated comment in docs config for intersphinx 
Intersphinx is in use since 6a396c7eb8.
 2020-10-05 08:34:26 +02:00
Takeshi KOMIYA
598b85da75 Merge branch '3.x' into master 2020-10-04 22:41:44 +09:00
Takeshi KOMIYA
38bb377464 Merge pull request #8273 from sphinx-doc/7996_man_make_section_directory 
Close #7996: manpage: Add man_make_section_directory
 2020-10-04 22:40:41 +09:00
Takeshi KOMIYA
2d37ba4419 autodoc: deprecate SingledispatchFunctionDocumenter 
In #7487, SingledispatchFunctionDocumenter is merged into
FunctionDocumenter.  SingledispatchMethodDocumenter is also.  As a result,
They are no longer needed.  So this deprecates them.
 2020-10-04 13:50:10 +09:00
Takeshi KOMIYA
178c05b059 Close #7996: manpage: Add man_make_section_directory 
Add a new config variable; man_make_section_directory to make a
section directory on build man page.  During 3.x, it defaults to
False and will be changed to True on 4.0 release.
 2020-10-03 22:30:20 +09:00
François Freitag
5166dd194c Strip trailing whitespaces and normalize line endings 
Trailing whitespace do not have impact on the result, they are just
unused bytes. Most text editors are configured to strip trailing
whitespaces. Remove them all in one go.

Update a handful of files to use the UNIX line ending.
 2020-10-03 13:47:01 +02:00
Takeshi KOMIYA
f2c0dfe7c4 Close #6518: autodoc: Add autodoc_type_aliases 
autodoc_type_aliases allows to keep user defined type alises not
evaluated in the generated document.
 2020-10-03 16:03:35 +09:00
Takeshi KOMIYA
26ea870267 Merge branch '3.x' into master 2020-10-03 13:43:21 +09:00
Steve Piercy
81d7f2ee8a Update link to sphinxcontrib on GitHub 2020-09-26 16:32:59 -07:00
Bradley Dice
a0116eaa58 Fix typo: anchestor -> ancestor. 2020-09-20 17:36:01 -05:00
Takeshi KOMIYA
5ef4825b57 Close #8081: latex: Allow to add LaTeX package until writing tex file 
This postpones the evaluation of LaTeX packages via
``app.add_latex_package()`` to just before writing .tex file.  That
allows extensions to add LaTeX packages during reading and resolving
phase.
 2020-09-21 01:01:49 +09:00
Tetsuo Koyama
9fe3fe4f6b Add "Getting Started as a Translator" 2020-09-20 01:08:21 +09:00
Tetsuo Koyama
eef2f2a8b6 ✏️ Fix grammer 2020-09-20 00:53:57 +09:00
Jakob Lykke Andersen
500f45fd4c C, recursive alias declarations 
Fixes sphinx-doc/sphinx#8141
 2020-09-13 16:37:53 +02:00
Takeshi KOMIYA
bec30596a8 Merge branch '3.x' into master 2020-09-13 10:54:21 +09:00
Patrick Decat
7a3170b77a Fix some broken links 2020-09-03 15:22:50 +02:00
Falko Axmann
849ef212bc Fixes minor typo in quickstart.rst 2020-08-30 14:39:20 +02: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
Yves Chevallier
e45f55d32f Add rubric in Getting help 2020-08-15 13:34:57 +02:00
Takeshi KOMIYA
8412347f5d Merge branch '3.x' 2020-08-14 14:28:58 +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
Adam J. Stewart
fa8ad979af sphinx.ext.autodoc: fix typo in docs 2020-08-11 11:05:00 -05:00
Takeshi KOMIYA
a8927bcd3e Merge branch '3.x' 2020-08-08 18:16:59 +09:00
Michal Čihař
1bf7fe424e i18n: Add support for having single text domain 
The gettext_compact can now be a string which is then a single domain
for all documents.

Fixes #784
 2020-08-07 20:22:30 +02:00
Matt from Documatt
db9375363c Add link to third party themes on GitLab 
GitLab, alternative to GitHub, also contains a lot of beautiful open source themes.
 2020-08-07 14:46:19 +02:00
Takeshi KOMIYA
f743be0054 Merge pull request #8047 from cjmayo/typos 
Assorted typos including sphinx-buid in internationalization figure
 2020-08-06 02:38:07 +09:00
Takeshi KOMIYA
059dc108ba Close #6698: doctest: Add :no-trim-doctest-flags: options 
To control trimming doctest flags manually, this adds new options
:trim-doctest-flags: and :no-trim-doctest-flags: to doctest
directives.  It helps to describes doctest module itself in python
doc (see #6698).
 2020-08-05 23:39:05 +09:00