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,362 Commits 2 Branches 219 Tags 163 MiB
4d7558e968
Commit Graph

771 Commits

Author SHA1 Message Date
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
7cfcd81b76 doc: html_favicon and html_logo accept URL now 2021-01-23 20:49:15 +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
jfbu
2e22bd0a23 Merge branch 'master' into latex_font_for_pdflatex 2021-01-23 09:13:08 +01: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
5ce72f465b Merge branch '3.x' 2021-01-22 22:52:32 +09:00
jfbu
99a8b7f37f LaTeX: update default font configuration 
This replaces times package with tgtermes and tgheros (clones of Times and
Helvetica with better LaTeX support) and the monospace font from txfonts
package (txtt). This font is better matched with Times-like fonts than
Courier clones.

The changes applies to pdflatex/platex/uplatex.

Fixes: #8711
 2021-01-20 23:03:08 +01:00
Guillaume Melquiond
8a1d0d0da6 Allow production lists to refer to tokens from other production groups. 
Outside production lists, syntax "`foo:bar`" already makes it possible to
refer to the production "bar" of group "foo". This commit offers the same
feature inside production lists. Similarly to the reference syntax,
prefixing with a tilde prevents the group from being displayed.

This commit also makes it possible to use "`:bar`" to refer to production
"bar" from a production list without a group name. This is especially
useful when one has a main (unnamed) grammar and one or several named
extensions that need to refer to it.
 2021-01-20 17:57:52 +01:00
Takeshi KOMIYA
ca0677086d
Merge pull request #8658 from SolidifiedRay/feature-custom-section 
Close #8573: napoleon: Add more custom section styles
 2021-01-19 21:13:13 +09:00
SolidifiedRay
7ad85cd1e0 Close #8573: napoleon: Add more custom section styles 2021-01-18 11:43:40 -08:00
Takeshi KOMIYA
30f8640bab Merge branch '3.x' 2021-01-16 21:51:46 +09:00
Takeshi KOMIYA
b742bde8e6
Merge pull request #8684 from tk0miya/2030_automatic_dedent 
Fix #2030: automatic dedent support in code-block directive
 2021-01-14 01:11:02 +09:00
Takeshi KOMIYA
f81310708b
Merge pull request #8678 from tk0miya/doc_html_baseurl 
Fix #8677: doc: Update description of html_baseurl
 2021-01-14 01:10:12 +09:00
Takeshi KOMIYA
fddc42847f Fix #2030: automatic dedent support in code-block directive 2021-01-13 01:10:28 +09:00
Takeshi KOMIYA
32ac5f2e57 Close #207: Now highlight_language supports multiple languages 
This changes the structure of `highlight_options` to a dictionary that
maps language names to option dictionary.  It allows to setting pygments
options for multiple languages at once.
 2021-01-11 21:40:09 +09:00
Takeshi KOMIYA
5d07135a1e Fix #8677: doc: Update description of html_baseurl 2021-01-11 19:45:55 +09:00
Takeshi KOMIYA
f433581b04 doc: Fix highlight language 2021-01-10 22:22:30 +09:00
Takeshi KOMIYA
5460ea103b Merge branch '3.x' 2021-01-08 01:23:17 +09:00
Takeshi KOMIYA
a9c7dd7037 Merge branch '3.x' 2021-01-03 00:20:27 +09:00
Takeshi KOMIYA
e9a4ebf70d doc: Add explanation for the priority attribute of html_*_files 2021-01-03 00:16:10 +09:00
Hong Xu
1f020196a7 DOC: modules are only available when recursive is on 
See
7ecf6b88aa/sphinx/ext/autosummary/generate.py (L314-L315)
 2021-01-01 11:12:58 -08:00
Takeshi KOMIYA
a122397b4b Merge branch '3.x' 2020-12-29 18:37:45 +09:00
Takeshi KOMIYA
150f788e0e
Merge pull request #8600 from tk0miya/8132_project_copyright 
Close #8132: Add project_copyright confval as an alias of copyright
 2020-12-28 17:26:49 +09:00
Hong Xu
d9ca895dbb
Update autodoc.rst 2020-12-27 21:24:19 -08:00
Hong Xu
6927130ff1
Doc: Correct type: "TypeAlias" -> "AliasType" 2020-12-27 21:23:31 -08:00
Takeshi KOMIYA
c5a9d04d45
Merge branch '3.x' into 8132_project_copyright 2020-12-28 13:56:11 +09:00
Takeshi KOMIYA
c7d1536828 Close #8132: Add project_copyright confval as an alias of copyright 
Avoid to pylint error, add a new config variable; project_copyright
as an alias of `copyright`.
 2020-12-27 18:40:06 +09:00
Takeshi KOMIYA
9e9e486e65 Close #8022: autodoc: Allow to hide the value of the variables via metadata 
autodata and autoattribute directives does not show right-hand value of
the variable if its docstring contains ``:meta hide-value:`` in
info-field-list.
 2020-12-27 12:46:03 +09:00
Takeshi KOMIYA
2c98e909bf Merge branch '3.x' 2020-12-14 02:02:29 +09:00
Ned Batchelder
bac6ab8d0c Describe the intersphinx mapping a bit more 2020-12-13 08:04:55 -05:00
Takeshi KOMIYA
1d9eeedde3 Fix #8508: LaTeX: uplatex becomes a default setting of latex_engine for Japanese 
Since v2.3, Sphinx supports uplatex as an alternative of latex_engine for Japanese
docs (refs: #4186, #6841). uplatex is able to build a document without conversion
character encoding internally. It allows using unicode characters in documents.
Additionally, uplatex is compatible with platex (current default latex_engine for
Japanese docs).

This changes the default latex_engine for Japanese document to uplatex.
 2020-11-29 15:09:49 +09:00
Takeshi KOMIYA
da4c69c624
Merge pull request #8291 from QuentinSoubeyran/8285_napoleon_google_style_use_annotations 
Fix #8285: napoleon can use PEP526 annotations
 2020-11-28 18:11:30 +09:00
François Freitag
6b90a63f08 Fix #6629: linkcheck: Handle rate-limiting 
Follow the Retry-After header if present, otherwise use an exponential
back-off.
 2020-11-25 17:34:55 +01:00
Quentin Soubeyran
ec30f77712 refactored code and tests, prepared for numpy feature 2020-11-25 08:45:25 +01:00
Quentin Soubeyran
f268665292 added napoleon_google_attr_annotations option to use PEP 526 on google style 2020-11-25 08:45:25 +01:00
Takeshi KOMIYA
3a4ae2092a Merge branch '3.x' 2020-11-21 01:01:36 +09:00
Takeshi KOMIYA
5676fdeb4e Rename :novalue: option to :no-value: option 
According to the existing options of autodoc directives, `:novalue:`
option is now renamed to `:no-value:` option.
 2020-11-15 14:20:30 +09:00
Marlon James
6082ce67a4 autodoc: document :novalue: option 2020-11-15 14:19:33 +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
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
Takeshi KOMIYA
598b85da75 Merge branch '3.x' into master 2020-10-04 22:41:44 +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
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
Falko Axmann
849ef212bc Fixes minor typo in quickstart.rst 2020-08-30 14:39:20 +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
Chris Mayo
fe4a158caf Fix typos in the documentation 2020-08-03 19:30:38 +01: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
c14c00397e Merge branch '3.x' 2020-08-01 16:59:00 +09:00
Ebram Shehata
df2d4839c4
Update basics.rst 2020-07-29 15:14:29 +02: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
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
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
Hameer Abbasi
a4413810bc Merge branch 'mathjax-3' of github.com:hameerabbasi/sphinx into mathjax-3 2020-07-24 17:01:39 +02:00
Hameer Abbasi
8f5ce152a1 Fold line. 2020-07-24 16:59:40 +02:00
Hameer Abbasi
98d3ed01ff Merge branch 'master' into mathjax-3 2020-07-24 16:58:55 +02:00
Takeshi KOMIYA
327c187284 Merge branch '3.x' 2020-07-24 23:49:45 +09:00
Hameer Abbasi
496ac3fe8b
Change MathJax 2 path string. 
Co-authored-by: Dmitry Shachnev <mitya57@users.noreply.github.com>
 2020-07-24 12:31:23 +02:00
Hameer Abbasi
746cf3505c Merge branch 'master' into mathjax-3 2020-07-24 11:53:27 +02:00
Hameer Abbasi
aed8f719ca Expand warning and refer to it from CHANGES. 2020-07-24 11:52:30 +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
Takeshi KOMIYA
897be0ebae Close #7784: i18n: The alt text for image is translated by default 
Make alt text for image translatable by default without settings of
gettext_additional_targets.
 2020-07-19 12:58:28 +09:00
Hameer Abbasi
72f3592796
Delete repeated word. 
Co-authored-by: Dmitry Shachnev <mitya57@users.noreply.github.com>
 2020-07-15 14:39:56 +02:00
Hameer Abbasi
436519743b Move to MathJax 3. 2020-07-15 13:09:08 +02: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
70d521ad9c Merge branch '3.x' 2020-07-11 21:59:58 +09:00
Takeshi KOMIYA
6dfbc5108e Close #7849: html: Add html_codeblock_linenos_style 2020-07-11 20:59:38 +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
Takeshi KOMIYA
1a223209f2 Merge branch '3.x' 2020-07-05 19:56:21 +09:00
Jakob Lykke Andersen
09e057edf2
Merge pull request #7906 from jakobandersen/noindexentry 
Add :noindexentry: option
 2020-07-05 09:25:18 +02:00
Jakob Lykke Andersen
c668500a4b Add :noindexentry: option 
Fixes sphinx-doc/sphinx#7052
 2020-07-04 19:34:00 +02:00
Takeshi KOMIYA
ec3754bd94 Merge branch '3.x' 2020-07-05 01:32:54 +09:00
Takeshi KOMIYA
44f4b2ad97 Merge tag 'v3.1.0' 2020-07-05 00:10:47 +09:00
Takeshi KOMIYA
0c24baaa0c doc: Update docs (refs: #7907) 2020-07-04 11:56:45 +09:00
Tim Metzler
5ba5cb60e3
Use double backticks for filename example 2020-07-03 19:08:53 +02:00
Tim Metzler
3982d526b2
Shorten line to less than 85 characters 2020-07-03 14:27:14 +02:00
Tim Metzler
9dcd88709c
Clarify language specific figures format 
I recently used sphinx for multilanguage documentation and found the explanation of the language specific figure format misleading. 
I replaced the underscores by periods and added a small example.
 2020-07-03 14:11:53 +02:00
Jakob Lykke Andersen
8c82ecbf2c
Merge pull request #7895 from jakobandersen/c_cpp_noindex 
C, C++: remove noindex option
 2020-07-02 15:38:45 +02:00
Jakob Lykke Andersen
ff5eb7cc2b C, C++: remove noindex option 
The option did nothing.
Improve error messages on duplicates.
 2020-06-30 13:52:18 +02:00
Jakob Lykke Andersen
7cbf54c210 C, add c:alias directive 2020-06-30 11:20:17 +02:00
Nguyễn Gia Phong
1a865069db napoleon: Add aliases Warn and Raise 2020-06-29 22:19:54 +07:00
Takeshi KOMIYA
42f29b6acf doc: Add modname separator tip for autodoc (refs: #7841) 2020-06-21 23:28:03 +09:00
Stefano David
f4cb82cd84 documentation for proper code-block cross-referencing 2020-06-07 18:06:51 +02:00
Takeshi KOMIYA
2fb5232b12 Fix typo 2020-06-06 01:21:35 +09:00
Takeshi KOMIYA
07d19ebe02
Merge pull request #7760 from Cielquan/feature/coverage_print_missing_as_warning 
coverage ext - config to log missing coverage
 2020-06-06 01:13:41 +09:00
Christian Riedel
f33eb15b83
documented coverage_show_missing_items confval 2020-06-05 17:42:26 +02:00
Stephen Finucane
375fb52fe4 docs: Add information about Sphinx trove classifiers 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-06-03 22:45:11 +01:00
Takeshi KOMIYA
068b9b5738 Merge branch '3.x' 2020-06-04 00:18:30 +09:00
Stephen Finucane
e0d3e0aa8c docs: Update reference to sphinx-contrib organization 
This is now well established on GitHub and the Bitbucket organization is
no longer maintained. Update the documentation to indicate this.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-06-02 21:58:05 +01:00
Takeshi KOMIYA
a7725ad8ca Close #7247: linkcheck: Add linkcheck_request_headers 2020-06-01 01:48:46 +09:00
Takeshi KOMIYA
34f3579330
Merge pull request #7748 from tk0miya/2106_autodoc_docstring_signature_for_overloads 
Close #2106: autodoc: Support multiple signatures on docstring
 2020-05-31 14:48:41 +09:00
Takeshi KOMIYA
350f5b3600
Merge pull request #7751 from stephenfin/doc/intro-section 
[doc] Remove the intro guide in favour of the quickstart guide
 2020-05-31 01:12:35 +09:00
Stephen Finucane
97d1b323b7 docs: Merge intro and quickstart guide 
The intro guide mostly contained out-of-date information or information
that was duplicated from elsewhere. Remove it in favour of an enhanced
quickstart guide.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-05-30 15:25:45 +01:00
Stephen Finucane
f07ad49c22 docs: Add usage, development index page 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-05-30 15:24:40 +01:00
Stephen Finucane
ceb72f9cd7 doc: Rework "latex" document 
Remove some unnecessary indentation, consistently document option
defaults, and fix some wrapping and whitespace.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-05-30 15:23:36 +01:00
Takeshi KOMIYA
800dcf0f0a Close #2106: autodoc: Support multiple signatures on docstring 2020-05-30 15:40:21 +09:00
Kai Welke
0ee57a6f6e
Fixed broken link to pygments lexers doc 2020-05-26 09:35:47 +02:00
Michaël Defferrard
5e5bd748e6
remove repeted word in reStructuredText Primer 2020-05-20 22:30:58 +02:00
Takeshi KOMIYA
752d3285d2 Update docs (refs: #7469) 2020-05-21 00:56:32 +09:00
Daniel Fremont
de4aca857c revisions per comments from tk0miya 2020-05-17 09:07:11 -07:00
Daniel Fremont
f9e9bdc4a0 Merge remote-tracking branch 'sphinx/3.x' into 3.x 2020-05-17 08:09:45 -07:00
Takeshi KOMIYA
3c7d35d2a2 Merge branch '3.x' 2020-05-17 19:12:56 +09:00
Takeshi KOMIYA
b1554ae25a doc: Fix wrong version info 2020-05-10 01:12:39 +09:00
Takeshi KOMIYA
e5dad73cf2 py domain: Add :canonical: option 2020-05-04 14:49:50 +09:00
Takeshi KOMIYA
f82151bda5 Merge branch '3.x' 2020-05-02 10:43:10 +09:00
Takeshi KOMIYA
71eddf3095 Merge branch '3.x' 2020-04-30 21:49:28 +09:00
Takeshi KOMIYA
155cb87452 doc: Fix examples of doctest extensions are still in py2 (refs: #7575) 2020-04-29 22:46:44 +09:00
Takeshi KOMIYA
aa773cbc88 Merge branch '3.x' 2020-04-28 01:42:37 +09:00
Takeshi KOMIYA
87308d9607 Close #7143: py domain: Add :final: option to py:*: directives 2020-04-28 01:24:29 +09:00
Takeshi KOMIYA
42aa293679 Merge branch '3.x' 2020-04-27 00:54:23 +09:00
Takeshi KOMIYA
037fe96dc1 Close #4030: autosummary: Add autosummary_context 2020-04-25 11:15:43 +09:00
Takeshi KOMIYA
c9e4945623
Merge pull request #7473 from eric-wieser/meta-public 
Add support for :meta public:
 2020-04-23 02:15:42 +09:00
Takeshi KOMIYA
6e28675727 doc: Fix version 2020-04-21 23:38:18 +09:00
Takeshi KOMIYA
7671bcc23b Remove autosummary_recursive configuration 
Now autosummary directive has :recursive: option to enable the
recursive feature individually.  So the configuration is no longer
needed.
 2020-04-21 23:38:18 +09:00
Takeshi KOMIYA
b9da9237bc Merge branch '3.x' into 6040_autosummary_recursive 2020-04-21 23:04:38 +09:00
Takeshi KOMIYA
476b73b6ca autosummary: Add :recursive: option to autosummary directive 2020-04-21 22:47:00 +09:00
Takeshi KOMIYA
c2c95ef587
Merge pull request #7411 from tk0miya/latex_theme_options 
LaTeX: Add `latex_theme_options` to override theme options
 2020-04-20 01:50:06 +09:00
Takeshi KOMIYA
12cb90c3fa
Merge pull request #7492 from tk0miya/7490_autosummary_caption 
Close #7490: autosummary: Add ``:caption:`` option to autosummary directive
 2020-04-20 00:52:45 +09:00
Takeshi KOMIYA
05aff200b1 LaTeX: Add :confval:latex_theme_options to override theme options 2020-04-20 00:51:08 +09:00
Takeshi KOMIYA
68375c92f2 Fix #7488: Update docs 2020-04-19 23:01:57 +09:00
Takeshi KOMIYA
adad0e62bb Merge branch '3.x' 2020-04-18 21:54:31 +09:00
Takeshi KOMIYA
1e3ce31b03
Merge pull request #7443 from mgeier/theme-options-toctree 
Add globaltoc_collapse and globaltoc_includehidden options
 2020-04-16 23:11:28 +09:00
Takeshi KOMIYA
dc46897768 Close #7490: autosummary: Add `:caption:` option to autosummary directive 2020-04-16 23:04:57 +09:00
Matthias Geier
3baa6e09e2 FIXUP: move "versionadded" 2020-04-15 21:02:41 +02:00
Takeshi KOMIYA
19d5d8d75c Fix #7477: imgconverter: Invoke "magick convert" command on Windows 2020-04-15 23:23:28 +09:00
Eric Wieser
0d7451c23d Add support for :meta public: 
A common use case for this is a class like `namedtuple`, which has a public `_replace` method that is so-named in order not to conflict with arbitrary user-provided attributes.

Rejected spellings include:
* `:meta not-private:`
* `:meta private: False`
 2020-04-14 08:41:45 +01:00
Matthias Geier
c17f00c7a2 DOC: globaltoc_collapse, globaltoc_includehidden 2020-04-13 19:22:17 +02:00
Takeshi KOMIYA
1aca70cf80 Merge branch '3.x' 2020-04-13 23:36:49 +09:00
Takeshi KOMIYA
b2a601a33d Merge branch '3.0.x' into 3.x 2020-04-13 23:36:10 +09:00
Jakob Lykke Andersen
09f66c690b
Merge pull request #7468 from jakobandersen/c_namespace 
C, add scoping directives
 2020-04-13 13:47:39 +02:00
Jakob Lykke Andersen
d4058eb67f C, parse attributes 2020-04-13 13:43:26 +02:00
Daniel Fremont
8ee7d908f3 updated corresponding documentation 2020-04-12 12:06:14 -07:00
Jakob Lykke Andersen
bbc7b6cc54 C, add scoping directives 2020-04-12 14:13:54 +02:00
Tetsuo Koyama
4983a12f21
➕ 🇧🇬 🇮🇳 🇦🇱 🇷🇸 2020-04-12 19:04:42 +09:00
Takeshi KOMIYA
10d7760156 Fix #7410: Allow to suppress "circular toctree references detected" warnings 2020-04-12 15:25:35 +09:00
Rick Wertenbroek
df1b05a659
Update Instalation.rst - Docker sphinx-quickstart 
I suggest adding the -it option to the docker run command for sphinx-quickstart since it is an interactive command.
Without interaction, the process will simply stop with the [Interrupted.] state after the first option
...
> Separate source and build directories (y/n) [n]: 
[Interrupted.]
 2020-03-25 11:18:18 +01:00
Takeshi KOMIYA
90fb44ee43 Merge branch '3.x' 2020-03-23 00:07:51 +09:00
Takeshi KOMIYA
ab75982be0 Fix document 2020-03-22 17:49:17 +09:00
Takeshi KOMIYA
8806cc257a
Merge pull request #7348 from tk0miya/7340_toctree_doc 
doc: Update about toctree directive
 2020-03-22 16:28:36 +09:00
Takeshi KOMIYA
c7e590818a Merge branch '3.x' 2020-03-21 17:53:22 +09:00
Takeshi KOMIYA
eccb9abe4a doc: Update about toctree directive 2020-03-21 16:37:34 +09:00
Jakob Lykke Andersen
f12a7f1ae2 Simplify backslash stripping 2020-03-20 13:26:45 +01:00
Jakob Lykke Andersen
e0f779ba3d Remove backslash stripping in domains. 
Adds several ways to reinstate the old behaviour.

Fixes sphinx-doc/sphinx#6462
 2020-03-20 12:25:31 +01:00
PythonCoderAS
c495b2a380
Correct minor typo 2020-03-18 21:49:41 -04:00
Jakob Lykke Andersen
b2ca906830 C, add expression parsing and expr role 2020-03-15 19:49:16 +01:00
Jakob Lykke Andersen
815a9c657d C, add new directives, fix xref lookup 2020-03-15 19:49:16 +01:00
Jakob Lykke Andersen
0f49e30c51 C, initial rewrite 2020-03-15 19:49:16 +01:00
Takeshi KOMIYA
9086ecdfff Merge branch '3.x' 2020-03-12 01:37:23 +09:00
Septatrix
97133d4bf0 Configure plantuml to generate svg files (fixes #7134) 2020-03-10 19:09:31 +01:00
Takeshi KOMIYA
e116613a3a Merge branch '3.x' 2020-03-10 01:15:52 +09:00
Takeshi KOMIYA
3e0618ba3a Deprecate codes for docutils-0.13 or 0.14 2020-03-07 19:36:41 +09:00
Takeshi KOMIYA
2bd7c19c7b Drop python 3.5 support 2020-03-07 18:06:39 +09:00
Takeshi KOMIYA
d517aa6c16 Close #7079: Make autodoc_typehints=description formal 2020-03-07 13:19:37 +09:00
Takeshi KOMIYA
f13c546862 doc: Update docs 2020-03-07 02:00:50 +09:00
Takeshi KOMIYA
cdbefb600f Support user defined LaTeX themes 2020-03-06 22:11:25 +09:00
Takeshi KOMIYA
73e99ab88b Update CHANGES and docs for PR #7064 2020-03-05 20:40:35 +09:00
Takeshi KOMIYA
93e519320b
Merge pull request #7227 from tk0miya/7217_docker 
Add a installation procedure for docker
 2020-02-29 16:35:15 +09:00
Takeshi KOMIYA
e6f8ed063c doc: Update installation 2020-02-29 16:22:55 +09:00
Takeshi KOMIYA
61b8edcb49 doc: Move docker section above "install from source" 2020-02-29 16:16:56 +09:00
Tetsuo Koyama
89490287e7
🆕 docker-sphinx 
Co-authored-by: tk0miya <i.tkomiya@gmail.com>
 2020-02-25 12:47:14 +09:00
Tetsuo Koyama
e20430aee1 🆕 docker-sphinx 2020-02-24 16:04:53 +09:00
Tetsuo Koyama
e3fa132f2b
⬆️ doc/usage/installation.rst 2020-02-24 16:00:47 +09:00
Tetsuo Koyama
14d8cf636a
🆕 docker-sphinx 2020-02-24 15:41:27 +09:00
Takeshi KOMIYA
34255f6014 doc: Recommend to use py38-sphinx instead of py36-sphinx 2020-02-24 12:43:51 +09:00
Takeshi KOMIYA
448937eb4d doc: Remove mention about py2 2020-02-24 12:43:00 +09:00
Takeshi KOMIYA
bfce1a71f6
Merge pull request #7087 from geographika/named-index-links 
Add name option for the index directive
 2020-02-23 12:27:57 +09:00
sethg
b20d74f8a0 Review updates 2020-02-22 13:31:18 +01:00
Takeshi KOMIYA
b162273962
Merge pull request #7064 from tk0miya/7025_nosearch 
Close #7025: html search: full text search can be disabled via metadata
 2020-02-22 17:53:01 +09:00
Takeshi KOMIYA
30b0361f9c Close #7025: html search: full text search can be disabled via metadata 2020-02-22 17:34:44 +09:00
Takeshi KOMIYA
a033d53c24 Close #7032: html_scaled_image_link is disabled for individual image 2020-02-18 01:48:11 +09:00
sethg
28ad370343 Add option to docs 2020-02-16 21:37:41 +01:00
Takeshi KOMIYA
24b9efb65e doc: Update usage/quickstart.rst to adjust latest quickstart 2020-02-17 02:12:27 +09:00
Neal McBurnett
b620a8a6cc
Fix typos 
bad quoting, better word usage.
 2020-02-09 19:12:52 -07:00
Neal McBurnett
9b125cf8e9
Clarify documentation on use of doctest extension 
When I first read this section, I was mightily confused due to lack of context and the use of the passive voice.
I think this phrasing clarifies the context and indicates more clearly what the documentation author does
vs what the doctest extension and builder do.
But I'm a newbie here, so please ensure that I got this right....
 2020-02-09 16:59:39 -07:00
Takeshi KOMIYA
2e87ee85a2 Merge branch '2.0' 2020-02-09 00:57:53 +09:00
Takeshi KOMIYA
1e5342faa9
Merge pull request #7109 from sphinx-doc/6033_doc_for_tocdepth 
docs: Add a restriction note about tocdepth (refs: #6033)
 2020-02-08 18:37:06 +09:00
Takeshi KOMIYA
f6acd061f3 docs: Add a restriction note about tocdepth (refs: #6033) 2020-02-07 23:59:20 +09:00
Matthias Geier
327778ca22
Disable arrow keys when a modifier key is pressed (#7089) 
* Disable arrow keys when a modifier key is pressed

Closes #7088.

* #7088 document key navigation option

* add change note for #7088

Co-authored-by: Timotheus Kampik <timotheus.kampik@signavio.com>
 2020-02-07 13:08:51 +01:00
Takeshi KOMIYA
0c0d037059
Merge pull request #7083 from tk0miya/update_docs 
doc: Make desc of gettext_additional_targets easy to read
 2020-02-01 13:39:21 +09:00
Takeshi KOMIYA
423a7a7131 doc: Make desc of gettext_additional_targets easy to read 2020-02-01 13:12:32 +09:00
Takeshi KOMIYA
179a1f9cc2 py domain: Support type annotations for variables 
This adds ``:type:`` and ``:value:`` options to both ``py:data``
and ``py:attribute`` directives.  It allows to describe its
annotation in detail.
 2020-02-01 12:58:27 +09:00
Takeshi KOMIYA
e7a0af807a Merge branch '2.0' 2020-01-30 23:29:32 +09:00
Jakob Lykke Andersen
9fa23615ec Fixes from review 2020-01-25 17:02:59 +01:00
Takeshi KOMIYA
5397664d42 Add a new extension: sphinx.ext.autodoc.typehints 2020-01-25 17:56:39 +09:00
Jakob Lykke Andersen
c084c3f124 Implement scoping for productionlist 
Fixes sphinx-doc/sphinx#3077
 2020-01-22 22:32:30 +01:00
Takeshi KOMIYA
347e301727 Merge branch '2.0' 2020-01-19 22:47:02 +09:00
Takeshi KOMIYA
74a5f350a1 Add new event: autodoc-before-process-signature 2020-01-13 13:16:59 +09:00
Takeshi KOMIYA
f169560395
Merge pull request #6979 from tk0miya/6830_autodoc_private 
Close #6830: autodoc: consider a member private if docstring contains :private:
 2020-01-11 15:14:52 +09:00
Takeshi KOMIYA
cad1f86dd8 Merge branch '2.0' 2020-01-11 02:56:58 +09:00
Ralf Gommers
659c66ad98 Update documentation of download role for addition of hash in subdir 
This was changed in gh-5377, but that forget the (now slightly
misleading) documentation.

Discovered in https://github.com/numpy/numpy.org/pull/14, where
we were relying on download links being stable.
 2020-01-07 13:06:16 +01:00
Takeshi KOMIYA
b968bb91e9 Close #6830: autodoc: consider a member private if docstring has "private" metadata 2020-01-04 13:28:07 +09:00
Takeshi KOMIYA
0319faf8f1 Merge branch '2.0' 2020-01-01 14:40:39 +09:00
Takeshi KOMIYA
2f36d792f3 Update CHANGES for PR #5230 2020-01-01 12:59:20 +09:00
Takeshi KOMIYA
e628afd5cd Merge branch '2.0' 2020-01-01 11:39:46 +09:00
Takeshi KOMIYA
7851550cd8 doc: Fix ambiguous confval entries and references 2019-12-29 23:23:46 +09:00
Takeshi KOMIYA
18e25d680d Close #6966: graphviz: Support `:class:` option 2019-12-27 22:38:10 +09:00
Takeshi KOMIYA
1fc4e8c251 Merge branch '2.0' 2019-12-25 22:44:12 +09:00
Takeshi KOMIYA
de9ee3e70a doc: Fix sphinx.ext.duration will be added since 2.4.0 2019-12-25 22:43:56 +09:00
Takeshi KOMIYA
e83bb29789
Merge pull request #6873 from tk0miya/5923_autodoc_inherited_members_can_ignore_specific_superclass 
Close #5923: autodoc: allow not to document inherited members of specific super class
 2019-12-22 16:30:56 +09:00
Takeshi KOMIYA
a209002b81 doc: Add examples for :inherited-members: 2019-12-22 16:05:45 +09:00
Takeshi KOMIYA
d47f38e22d Merge branch '2.0' 2019-12-21 12:21:49 +09:00
Takeshi KOMIYA
29687a29f1 Close #6446: Add sphinx.ext.durations to inspect durations of build 2019-12-16 00:47:23 +09:00
Takeshi KOMIYA
712c20a3d9 Merge branch '2.0' 2019-12-16 00:05:35 +09:00
Damien Ayers
1a54a7229c Fix documentation typo 
(cherry picked from commit 937c684960)
 2019-12-13 23:27:04 +01:00
Damien Ayers
937c684960
Fix documentation typo 2019-12-13 12:33:02 +11:00
jfbu
2199a127e8 Typo (refs #6491) 2019-12-09 22:57:45 +01:00
Takeshi KOMIYA
7ec567b6d0 Merge branch '2.0' 2019-12-09 00:13:42 +09:00
Takeshi KOMIYA
9e40f2a603 doc: rewrite options for code-block by directive:option directive 2019-12-08 21:33:06 +09:00
Takeshi KOMIYA
d82e0bb5a5 doc: rewrite options for highlight by directive:option directive 2019-12-08 21:33:06 +09:00
Takeshi KOMIYA
fb9adbf0be
Merge pull request #6870 from stsewd/update-docs-intersphinx-with-basic-auth 
Update docs about intersphinx and basic auth support
 2019-12-03 01:42:37 +09:00
Takeshi KOMIYA
7292ab7eef Merge branch '2.2.2' into 2.0 2019-12-03 01:19:02 +09:00
Santos Gallegos
46c68302be Be more specific about the type of login 2019-12-02 11:07:17 -05:00
Takeshi KOMIYA
7c79a6b8d1 Close #5923: autodoc: allow not to document inherited members of specific super class 2019-12-01 12:51:28 +09:00
Takeshi KOMIYA
15c266c445 Merge branch '2.0' 2019-11-30 21:52:42 +09:00
Takeshi KOMIYA
82a6048f12 Fix typo 2019-11-28 23:31:08 +09:00
Santos Gallegos
f7c1e9190a Linter 2019-11-27 15:38:26 -05:00
Santos Gallegos
a72d8f6808 Update docs about intersphinx and basic auth support 
This was added in #2089 but the docs don't mention it.
 2019-11-27 15:23:52 -05:00
Takeshi KOMIYA
1cc1481771
Merge pull request #6866 from tk0miya/napoleon_doc_fix 
doc: URL of numpydoc has changed
 2019-11-27 01:25:33 +09:00
Takeshi KOMIYA
82b2b1752a doc: URL of numpydoc has changed 2019-11-27 00:12:32 +09:00
Takeshi KOMIYA
9bd64e4e2a
Merge pull request #6862 from tk0miya/6854_update_supported_languages_list 
Update supported languages (refs: #6854)
 2019-11-27 00:04:22 +09:00
jfbu
dc53404d48 Fix markup issue in our docs 2019-11-26 14:22:17 +01:00
jfbu
d398959230 Fix typo in docs 2019-11-26 14:11:40 +01:00
Takeshi KOMIYA
995dfa4e73
Merge pull request #6816 from jonashaag/linkcheck-auth 
Add linkcheck_auth option
 2019-11-26 01:29:30 +09:00
Takeshi KOMIYA
1faf14d411 Update supported languages (refs: #6854) 2019-11-26 01:22:14 +09:00
Takeshi KOMIYA
6de29cdb84
Merge pull request #6854 from jfbu/doc_mention_Greek_as_supported_language 
DOC: add Greek to list of supported languages
 2019-11-26 00:56:34 +09:00
Jonas Haag
df2f80c755 Add linkcheck_auth option 2019-11-25 09:53:45 +01:00
jfbu
70f087990b DOC: add Greek to list of supported languages 2019-11-22 19:15:59 +01:00
Takeshi KOMIYA
c65243325c
Merge branch '2.0' into 6798_autosummary_emits_skip_member_event 2019-11-21 00:45:57 +09:00
Sylvestre Ledru
3aef93c4a3
Fix the URL to https://pygments.org/docs/lexers.html 2019-11-20 14:49:15 +01:00
Takeshi KOMIYA
c6f0eb215a Fix #4186: LaTeX: Support upLaTeX as a new latex_engine (experimental) 2019-11-17 17:37:48 +09:00
Takeshi KOMIYA
6644830941 Merge branch '2.0' 2019-11-17 14:24:04 +09:00
Joe
1fd7176f89 Fix link to pygments lexer 2019-11-16 18:11:14 -08:00
Takeshi KOMIYA
66c3dd3adb Close #6798: autosummary: emit `autodoc-skip-member` event on generating stub file 2019-11-16 18:19:31 +09:00
Tetsuo Koyama
7fbd9c02d0 🎨 Fixed issue #6789 2019-11-04 20:28:24 +09:00
Takeshi KOMIYA
32763520a3 Close #1331: Change default User-Agent header 2019-10-27 02:05:33 +09:00
Takeshi KOMIYA
a6a2a59ab0 Merge branch '2.0' 2019-10-20 13:43:30 +09:00
Takeshi KOMIYA
cb22be80c2 Merge branch '2.2.1' into 2.0 2019-10-20 13:42:10 +09:00
Takeshi KOMIYA
a950df1908 Close #6729: HTML theme: agogo theme now supports rightsidebar option 2019-10-14 14:26:33 +09:00
jfbu
7be68b7c4b Add latexpdf support for Greek as main language (via xelatex use) 
Closes: #6710
 2019-10-01 10:27:43 +02:00
Takeshi KOMIYA
01f8dad160 Merge branch '2.0' 2019-08-19 00:37:30 +09:00
ExplorerLog
edff2824e9
Update configuration.rst 
Add a comma
 2019-08-16 16:29:29 +08:00
jfbu
4ae5414ee5 Update our docs for imgmath_latex (refs: #6610) 2019-08-03 12:00:24 +02:00
jfbu
47cd262b3e Merge branch '2.0' 2019-08-01 18:30:48 +02:00
jfbu
7c59e44eaa Fix version changed info in our document for imgmath 2019-08-01 18:24:28 +02:00
jfbu
da3763170e Reorganize documentation of the imgmath configuration variables 2019-08-01 17:52:28 +02:00
jfbu
505ff622c2 More robust code for getting saved "depth" of svg inline math snippet 2019-08-01 17:52:28 +02:00
jfbu
1adf12bfa7 Make imgmath_use_preview work also for svg output 2019-08-01 17:52:28 +02:00
Timotheus Kampik
0662a3ecd6
#6503 document meta directive (#6562) 
#6503 document meta directive

The `meta` directive has partly Sphinx-specific behavior
and hence needs to be documented
 2019-07-08 22:48:41 +02:00
woutdenolf
9dc9b8754d Merge with master and address code review 2019-07-08 08:29:23 +02:00
Takeshi KOMIYA
4af90fcf75 Fix #247: autosummary: Add autosummary_generate_option to overwrite old stub file 2019-07-07 16:18:49 +09:00
Dull Bananas
e24709c2df
Clarify Windows installation 2019-07-05 18:41:22 -07:00
Takeshi KOMIYA
c18dcf08f9 Merge branch '2.0' 2019-06-30 01:08:48 +09:00
Takeshi KOMIYA
828beb12e0 doc: Update document for :annotation: option (refs: #6495) 2019-06-29 18:43:30 +09:00
Takeshi KOMIYA
5d42659e33 Merge branch '2.0' 2019-06-15 23:39:44 +09:00
woutdenolf
ec8656bd27 [autosummary] remove recursion limit and module/package separation 2019-06-02 16:26:40 +02:00
Takeshi KOMIYA
ce2f9c2b94 Close #5124: graphviz: :graphviz_dot: option is renamed to :layout: 2019-06-02 21:33:34 +09:00
Takeshi KOMIYA
c4f44bdd22 Merge branch '2.0' 2019-06-02 21:17:38 +09:00
Takeshi KOMIYA
1303ea7cdf docs: Use directive:option in extensions/graphviz 2019-06-02 18:18:55 +09:00
Takeshi KOMIYA
5da74898c3 Merge branch '2.0' 2019-06-02 01:09:09 +09:00
Takeshi KOMIYA
4c19ab7058 Merge commit '54d5fcfaebc3364044761d30c0fed6bd4d3052c3' 2019-06-02 01:02:54 +09:00
Takeshi KOMIYA
91fceb4b5f Merge branch '2.0.2' into 2.0 2019-06-02 00:58:46 +09:00
woutdenolf
4fb58b2146 [autosummary] doclint violation 2019-06-01 13:08:23 +02:00
woutdenolf
140ae00baa
Merge branch 'master' into feature-autosummary-packages 2019-06-01 12:42:28 +02:00
Takeshi KOMIYA
54d5fcfaeb
Merge pull request #6416 from tk0miya/2310_force_highlighting 
Add :force: option to code directives
 2019-06-01 14:17:53 +09:00
Takeshi KOMIYA
e001d358d0 Add :force: option to code directives 2019-06-01 13:42:57 +09:00
Takeshi KOMIYA
c6d840d95a doc: Change wording for contents directive (refs: #6265) 2019-06-01 11:27:38 +09:00
Takeshi KOMIYA
ce3c5735cd Merge branch '2.0' 2019-06-01 01:45:47 +09:00
Takeshi KOMIYA
2afba22cee
Merge pull request #6397 from tk0miya/6361_autodoc_typehints 
Close #6361: autodoc: Add autodoc_typehints to suppress typehints from signature
 2019-06-01 01:07:37 +09:00
gilch
e7239053b7
Grammar corrections 2019-05-29 19:41:45 -06:00