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,543 Commits 2 Branches 219 Tags
a3cfdffa9b91322bca2ba97db47441b237f94007
Commit Graph

2809 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
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
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
Jakob Lykke Andersen
09e057edf2 Merge pull request #7906 from jakobandersen/noindexentry 
Add :noindexentry: option
 2020-07-05 09:25:18 +02:00
Takeshi KOMIYA
fe444f70d8 Merge pull request #7911 from tk0miya/7907_update_docs 
doc: Update docs (refs: #7907)
 2020-07-05 12:22:19 +09:00
Jakob Lykke Andersen
c668500a4b Add :noindexentry: option 
Fixes sphinx-doc/sphinx#7052
 2020-07-04 19:34:00 +02:00
Takeshi KOMIYA
814efa55c4 Merge pull request #7897 from JulienPalard/typo 
FIX: Typo in tutorial/todo.
 2020-07-05 01:33:54 +09:00
Takeshi KOMIYA
0c24baaa0c doc: Update docs (refs: #7907) 2020-07-04 11:56:45 +09:00
Takeshi KOMIYA
f27dfe337e Merge pull request #7907 from tmetzl/patch-1 
doc: Clarify language specific figures format in docs
 2020-07-04 11:48:28 +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
Chris Holdgraf
ef03bcc6ea output files comment 2020-07-02 13:46:44 -07:00
Chris Holdgraf
853060a646 events 2020-07-02 13:42:53 -07: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
Julien Palard
527a0361f1 FIX: Typo in tutorial/todo. 2020-06-30 17:13:19 +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
dce45413e6 Merge pull request #7762 from tk0miya/7247_linkcheck_request_headers 
Close #7247: linkcheck: Add linkcheck_request_headers
 2020-06-05 01:17:31 +09:00
Stephen Finucane
227bbf6559 docs: Expand organization document 
Provide some guidance on how one can become a core developer and explain
the different types of contribution one can make.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-06-02 12:13:31 +01:00
Stephen Finucane
fa5fadc3f3 docs: Tweaks to code of conduct 
- Replace unicode quotes with ascii, since Sphinx will automatically
  translate these for us
- Move the header to the root document
- Use an admonition instead of a header for the attribution section

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-06-02 12:10:24 +01:00
Stephen Finucane
6b480c97b2 docs: Rework contributing document, re-add CONTRIBUTING 
Reorder this to flow a little better and re-add the CONTRIBUTING
document, which now simply points to the main documentation.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-06-02 12:10:21 +01:00
Stephen Finucane
d3021f644f docs: Add contributing document 
This completes the migration from the CONTRIBUTING document to the new
in-tree contributing guide. The CONTRIBUTING document itself is
temporarily removed so that git will correctly mark the document as
having been moved. A future change will re-add this document as well as
rework the new contributing document.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-06-02 12:08:34 +01:00
Stephen Finucane
a33483f154 docs: Add release process document 
This is based on content extracted from the CONTRIBUTING document.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-06-02 11:43:44 +01:00
Stephen Finucane
6b19678253 docs: Add organization overview 
Provide an introduction to how the Sphinx team is organized. This will
be expanded upon in a future change.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-06-02 11:43:44 +01:00
Stephen Finucane
6a5921d7b2 docs: Add "project internals" guide 
This is modelled off Django's guide of the same name [1]. In summary,
this will contain most of the information previously found in the
CONTRIBUTING document. For now, we move just the code of conduct and
authors documents.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-06-02 11:43:44 +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
212fd67b9f Merge pull request #7755 from stephenfin/doc/docutils-vs-sphinx 
[doc] Compare docutils and Sphinx
 2020-05-31 12:21:16 +09:00
Takeshi KOMIYA
59e0746cb5 doc: Remove intro.rst (ref: #7751) 2020-05-31 12:06:45 +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
Takeshi KOMIYA
6be72c6ed2 Merge pull request #7752 from stephenfin/doc/latex-rework 
[doc] Rework "latex" document
 2020-05-31 01:09:23 +09:00
Stephen Finucane
f3360e6922 docs: Fix typo, replace field lists with paragraphs 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-05-30 15:43:05 +01:00
Stephen Finucane
aaf2dafd63 docs: Compare docutils with Sphinx 
Add an FAQ entry comparing the two.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-05-30 15:38:12 +01:00
Stephen Finucane
e4e5c509b6 doc: Rework "templating" documents 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-05-30 15:29:13 +01: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
52bb0b02bb docs: Fix a typo and some indentation 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-05-30 15:23:36 +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