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,515 Commits 2 Branches 219 Tags 163 MiB
a7bbedfbb7
Commit Graph

405 Commits

Author SHA1 Message Date
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
d2fdc851fa doc: Add translation.png to build latexpdf successfully 2020-07-07 22:19: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
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
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
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
b1554ae25a doc: Fix wrong version info 2020-05-10 01:12:39 +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
87308d9607 Close #7143: py domain: Add :final: option to py:*: directives 2020-04-28 01:24:29 +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
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