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,545 Commits 2 Branches 219 Tags 163 MiB
26855f92d8
Commit Graph

15545 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Luke Lau
1e7d9269e9 Let option directive support args in the form of foo[=bar] 
This slightly tweaks the regex so that command line flags of the form
foo[=N] are properly split up. This is useful for any programs that can
take `--foo` as a flag on its own as well as with an extra argument
`--foo=12`.
 2020-06-03 16:35:00 +01:00
Takeshi KOMIYA
85da1b6072 Fix #7723: LaTeX: pdflatex crashed when URL contains a single quote 2020-06-04 00:31:53 +09:00
Takeshi KOMIYA
7140d85fc4
Merge pull request #7776 from tk0miya/3.x 
Fix mypy violations (with mypy-0.780)
 2020-06-03 23:55:40 +09:00
Takeshi KOMIYA
9b45b00bd4 Fix mypy violations (with mypy-0.780) 2020-06-03 23:47:29 +09:00
Takeshi KOMIYA
6a55947e9f Merge branch '3.0.x' into 3.x 2020-06-03 23:46:13 +09:00
Takeshi KOMIYA
ed75950017
Merge pull request #7775 from tk0miya/mypy-0.780 
Fix mypy violations (with mypy-0.780)
 2020-06-03 23:43:13 +09:00
Takeshi KOMIYA
b8fbd3d9c6 Fix mypy violations (with mypy-0.780) 2020-06-03 23:31:43 +09:00
Takeshi KOMIYA
cee921fe41
Merge pull request #7753 from stephenfin/bindep-integration 
Extend bindep integration to dpkg-based distros (Ubuntu, Debian, ...)
 2020-06-03 22:50:45 +09:00
Jakob Lykke Andersen
93d6b1bbc6
Merge pull request #7670 from jakobandersen/cpp_requires_clause 
C++, parse (trailing) requires clauses
 2020-06-02 19:49:18 +02:00
Jakob Lykke Andersen
afb4d883f7 C++, parse (trailing) requires clauses 
Fixes sphinx-doc/sphinx#7295
 2020-06-02 19:27:01 +02:00
Jakob Lykke Andersen
3419079fb0 Fix CHANGES, again 2020-06-02 19:11:19 +02:00
Jakob Lykke Andersen
f5b04114da Fix CHANGES 2020-06-02 18:54:12 +02:00
Jakob Lykke Andersen
590408e77c
Merge pull request #7769 from jakobandersen/c_cpp_display_string_ops 
C and C++, don't crash during stringification
 2020-06-02 18:50:49 +02:00
Takeshi KOMIYA
b3211318bd
Merge pull request #7750 from stephenfin/doc/internals-section 
[doc] Add project internals guide
 2020-06-03 01:50:34 +09:00
Jakob Lykke Andersen
e37d080729 C and C++, don't crash during stringification 
Specifically when generating display strings for unary expressions and fold
expressions.

Fixes sphinx-doc/sphinx#7763
 2020-06-02 18:14:04 +02: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
49de4ab1a1 Support overloaded constructors (__call__, __init__ and __new__) 2020-06-02 00:44:07 +09:00
Takeshi KOMIYA
a7725ad8ca Close #7247: linkcheck: Add linkcheck_request_headers 2020-06-01 01:48:46 +09:00
Cielquan
42b755db2e
added test for show_missing_items True 2020-05-31 18:38:21 +02:00
Cielquan
d83f34794c
fixed color imports in coverage.py 2020-05-31 17:56:14 +02:00
Takeshi KOMIYA
fb2f777079 Close #3610: autodoc: Support overloaded functions 2020-05-31 23:59:32 +09:00
Cielquan
754b48c8d6
reduced colors on info level 2020-05-31 16:49:02 +02:00
Cielquan
baaa32c4a3
fixed line length 2020-05-31 16:40:37 +02:00
Takeshi KOMIYA
640bb2e586 pycode: Detect @overload decorators 2020-05-31 23:22:20 +09:00
Takeshi KOMIYA
a59f83b6bd Add sphinx.util.inspect:signature_from_ast() 2020-05-31 23:22:20 +09:00
Takeshi KOMIYA
c063c9c0fe
Merge pull request #7757 from tk0miya/7756_posonlyargs 
Fix #7756: py domain: The default value for posonlyarg is not shown
 2020-05-31 23:21:21 +09:00
Takeshi KOMIYA
3c0e3d6705
Merge pull request #7749 from tk0miya/4422_support_GenericAlias 
Close #4422: autodoc: Support GenericAlias
 2020-05-31 23:19:14 +09:00
Cielquan
e6cf7c0922
merged new config options into coverage_show_missing_items 2020-05-31 16:17:56 +02:00
Cielquan
c39ed6efbd
added config to log missing c/py coverage 2020-05-31 12:43:47 +02:00
Takeshi KOMIYA
3c5a9442c2
Merge branch '3.x' into 4422_support_GenericAlias 2020-05-31 14:49:13 +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
bb0b69544b Fix #7756: py domain: The default value for posonlyarg is not shown 2020-05-31 12:21:55 +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
0e6e66f763
Merge pull request #7759 from tk0miya/fix_docs 
doc: Remove intro.rst (ref: #7751)
 2020-05-31 12:16:50 +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
Takeshi KOMIYA
b072c55d5c
Merge pull request #7754 from stephenfin/doc/rework-templating 
[doc] Rework "templating" documents
 2020-05-31 01:06:23 +09:00
Stephen Finucane
45fc53ad5a bindep: Use dpkg instead of ubuntu classifier 
This allows us to target Debian too.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-05-30 16:02:49 +01: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