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,930 Commits 2 Branches 219 Tags
624f6937194e1acfe7311faf6e27e370c3118e55
Commit Graph

2851 Commits

Author SHA1 Message Date
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
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
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
Jakob Lykke Andersen
500f45fd4c C, recursive alias declarations 
Fixes sphinx-doc/sphinx#8141
 2020-09-13 16:37:53 +02: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
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
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
Chris Mayo
9bac86a2fc Fix typo sphinx-buid in internationalization figure 2020-08-03 19:30:38 +01:00
Chris Mayo
fe4a158caf Fix typos in the documentation 2020-08-03 19:30:38 +01:00
Takeshi KOMIYA
46f0b3063d refactor: autodoc: Add EMPTY that matches to no members 
Add a special class `_Empty` to make the comparison of
:exclude-members: option simply.  It never matches to any members.
 2020-08-03 01:59:53 +09:00
Takeshi KOMIYA
57af828882 Merge pull request #8035 from tk0miya/8034_argument_for_private-members 
Close #8034: autodoc: :private-member: can take an list of member names
 2020-08-03 01:57:13 +09:00
Takeshi KOMIYA
af15593c0c Close #7768: i18n: figure_language_filename supports {docpath} token 
To build structured i18n imaging directory, figure_language_filename
now supports `{docpath}` token that is a dirname of the current
document.
 2020-08-02 16:28:54 +09:00
Takeshi KOMIYA
d7a84e83cc Close #8034: autodoc: :private-member: can take an list of member names 
Now :private-member: option can take an explicit list of member names to
be documented as its arguments (like :special-members: does).
 2020-08-02 01:27:14 +09:00
Takeshi KOMIYA
f71b26ac56 Merge branch '3.x' into 7993_texinfo_for_nested_desc 2020-08-01 15:50:55 +09:00
Chris Holdgraf
b8ee3ac9a4 moving extension dev overview 2020-07-29 10:38:18 +01:00
Chris Holdgraf
84f7dffd99 comments 2020-07-29 10:38:18 +01:00
Chris Holdgraf
c7085162d1 rearranging a few docs and small updates 2020-07-29 10:38:18 +01:00
Chris Holdgraf
924befa07e Update doc/development/tutorials/builders.rst 2020-07-29 10:38:18 +01:00
Chris Holdgraf
729dcd0e03 flake8 2020-07-29 10:38:18 +01:00
Chris Holdgraf
60b105d6aa several documentation improvements to theming, templating, and extension development 2020-07-29 10:38:18 +01:00
Takeshi KOMIYA
e98f39d21d Fix #7993: texinfo: TypeError is raised for nested object descriptions 
The texinfo writer remembers the current desc node to render
a desc_annotation node.  This makes the mechanism robust to support
nested object descriptions.
 2020-07-25 22:57:12 +09:00
Takeshi KOMIYA
3336dcc2ae Merge pull request #7997 from sphinx-doc/fix/6863 
fix 6863: add description literalinclude option (start/end have same string)
 2020-07-25 22:53:48 +09:00
Yoshiki Shibukawa
70aa913bb2 fix 6863: add description literalinclude option (start/end have same string) 2020-07-25 22:36:06 +09:00
Takeshi KOMIYA
778e297577 Update CHANGES for PR #7690 2020-07-25 21:45:13 +09:00
Takeshi KOMIYA
ac0a800265 Merge pull request #7690 from keewis/transform_numpy_parameter_types 
preprocessing numpy types
 2020-07-25 21:41:32 +09:00
Keewis
6ae1c601b9 add a section about napoleon_type_aliases to the documentation 2020-07-25 11:49:58 +02:00
Keewis
530793d997 update the link to the official docstring guide 2020-07-25 11:37:32 +02: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
Jakob Lykke Andersen
18b00d8cff Add docs and CHANGES for C changes 2020-07-14 11:48:58 +02:00
Johannes Lade
91285f39a6 Update description of autosummary_generate_overwrite 
The old description was confusing. Maybe it's just me not being a native speaker, but I think it was wrongly worded.
 2020-07-13 14:03:06 +02:00
Takeshi KOMIYA
e31fce0766 Close #7902: html theme: Add a new option globaltoc_maxdepth 2020-07-11 23:11:59 +09:00
Takeshi KOMIYA
6dfbc5108e Close #7849: html: Add html_codeblock_linenos_style 2020-07-11 20:59:38 +09:00
Takeshi KOMIYA
f3811a1c36 doc: Remove broken PDF image 
It was added unexpectedly in #7924.
 2020-07-11 00:28:22 +09:00
Takeshi KOMIYA
98a854deca Merge pull request #7924 from tk0miya/7921_translation.png 
doc: Add translation.png to build latexpdf successfully
 2020-07-10 02:44:11 +09:00
Joel Nothman
72ca2bdffc Add autosummary_filename_map config to avoid clashes 2020-07-08 16:51:57 +10:00
Takeshi KOMIYA
d2fdc851fa doc: Add translation.png to build latexpdf successfully 2020-07-07 22:19:21 +09:00
Julien Palard
418576ddd1 Doc: Add missing 'env-merge-info' to the todo tutorial. 2020-07-06 17:55:55 +02:00