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
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
Stephen Finucane
84bb49ce2a
Extend bindep integration to Ubuntu
...
This provides a way to bootstrap a system for development but currently
only Fedora is supported. We should aim to integrate this into the CI
someway but that's a job for another day.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-05-30 14:35:11 +01:00
Takeshi KOMIYA
c1fd36cc9c
Close #4422 : autodoc: Support GenericAlias
2020-05-30 21:53:42 +09:00
Takeshi KOMIYA
e20f29e325
Add sphinx.util.inspect:isgenericalias()
2020-05-30 21:06:54 +09:00
Takeshi KOMIYA
800dcf0f0a
Close #2106 : autodoc: Support multiple signatures on docstring
2020-05-30 15:40:21 +09:00
Takeshi KOMIYA
9988d5ce26
Update CHANGES for PR #7746
2020-05-30 15:40:02 +09:00
Takeshi KOMIYA
a6d4381a1c
Merge pull request #7710 from tk0miya/github_actions
...
Do test with Windows on GitHub Actions
2020-05-30 13:40:17 +09:00
Takeshi KOMIYA
928149b730
Merge pull request #7746 from rsokl/patch-1
...
Fix bug in mathjax: newest 2.x version not being loaded by latest.js
2020-05-30 13:14:07 +09:00
Takeshi KOMIYA
339e3a9f3d
Merge pull request #7714 from tk0miya/7701_anonymous_indirect_target
...
Fix #7701 : LaTeX: Anonymous indirect target causes duplicated labels
2020-05-30 01:40:03 +09:00
Takeshi KOMIYA
28fe0d6399
Merge branch '3.x' into 7701_anonymous_indirect_target
2020-05-30 01:22:39 +09:00
Takeshi KOMIYA
03559f0574
Merge pull request #7738 from tk0miya/7734_napoleon_overescaped_underscore
...
Fix #7734 : napoleon: overescaped trailing underscore on attribute
2020-05-30 01:21:45 +09:00
Takeshi KOMIYA
7b414d0c9c
Update CHANGES for PR #7384
2020-05-29 23:08:28 +09:00
Takeshi KOMIYA
877055f8b2
Update CHANGES for PR #7711
2020-05-29 23:06:07 +09:00
Takeshi KOMIYA
19ad8a4302
Merge pull request #7384 from eric-wieser/property-annotation
...
autodoc: Respect type annotations in `__new__`, `metacls.__call__`, and builtin types
2020-05-29 23:05:32 +09:00
Takeshi KOMIYA
18f7d8f4ef
Merge pull request #7744 from tk0miya/fix_pypi_classifiers
...
Add py38 to the list of PyPI classifiers
2020-05-29 13:18:10 +09:00
Ryan Soklaski
1d332a2e0a
Update test_ext_math.py
...
Bump hardcoded mathjax version to 2.7.7
2020-05-28 23:15:39 -04:00
Ryan Soklaski
7e97de805d
Update mathjax to version 2.7.7
...
There is a bug in latest.js in versions 2.7.5 and below; when the current version on the CDN is 3.0 or higher, latest.js will not use the highest version of 2.x, but instead will use the version from which latest.js has been taken. See the warning section on this page: http://docs.mathjax.org/en/latest/upgrading/v2.html
This PR fixes that by pointing to 2.7.7, the latest version available on the CDN.
2020-05-28 22:55:31 -04:00
Takeshi KOMIYA
666c4a4cd8
Merge pull request #7711 from larsoner/meth
...
BUG: Fix check for meth
2020-05-29 02:40:41 +09:00
Takeshi KOMIYA
03bb9ff84a
Add py38 to the list of PyPI classifiers
2020-05-29 02:36:02 +09:00
Eric Wieser
d5584172ab
Refactor to simplify format_args, catch TypeError
2020-05-28 18:28:40 +01:00
Eric Larson
79d8bfb9e0
BUG: Fix check for meth
2020-05-28 13:21:00 -04:00
Eric Wieser
d229b120ad
Fix autoclass signature parsing
...
This fixes:
* Signatures defined by __new__
* Signatures defined by metaclasses
* Signatures defined by builtin base classes
All of these changes bring the sphinx docs inline with the behavior of `inspect.signature`.
Note that this changes autodoc to output `.. py:class: MyClass()` with parentheses even if no user-defined __init__ is present.
This is quite deliberate, as if no user-defined `__init__` is present the default is `object.__init__`, which indeed does not take arguments.
2020-05-28 08:36:56 +01:00
Takeshi KOMIYA
2c1bab44e8
Remove .appveyor.yml
2020-05-28 01:51:22 +09:00
Takeshi KOMIYA
27f85c7f4e
Do test with Windows on GitHub Actions
2020-05-28 01:51:22 +09:00
Takeshi KOMIYA
ee4c7d3a68
Merge pull request #7713 from tk0miya/3673_autodoc_sort_by_all
...
Fix #3673 : autodoc: bysource order does not work for a module having __all__
2020-05-28 01:50:24 +09:00
Takeshi KOMIYA
eb9263b8a0
Merge pull request #7725 from kai687/patch-1
...
Fixed broken link to pygments lexers doc
2020-05-28 01:49:16 +09:00
Takeshi KOMIYA
b2b57b9282
Merge pull request #7732 from tk0miya/refactor_test_project
...
refactor test_project: PathComparer is unnecessary for this case
2020-05-28 01:48:29 +09:00
Takeshi KOMIYA
a28c9ad842
Fix #7734 : napoleon: overescaped trailing underscore on attribute
2020-05-28 01:47:33 +09:00
Takeshi KOMIYA
36fd5bfa9a
refactor test_project: PathComparer is unnecessary for this case
2020-05-27 02:44:53 +09:00
Takeshi KOMIYA
c087d717f6
Merge pull request #7712 from tk0miya/refactor_autodoc_sort_members
...
refactor: autodoc: Sort members alphabetically when unknown order
2020-05-27 01:41:37 +09:00
Takeshi KOMIYA
d0779390d9
Merge branch '3.0.x' into 3.x
2020-05-27 00:38:23 +09:00
Takeshi KOMIYA
e3f9bf43f6
Bump version
2020-05-27 00:37:11 +09:00
Takeshi KOMIYA
b797f7f75c
Bump to 3.0.4 final
2020-05-27 00:34:47 +09:00
Kai Welke
0ee57a6f6e
Fixed broken link to pygments lexers doc
2020-05-26 09:35:47 +02:00
Matthias Geier
b345acc284
classic theme: default codetextcolor/codebgcolor doesn't override Pygments
...
Closes #7720 .
2020-05-24 20:39:31 +02:00
Matthias Geier
1f47eefb2f
CSS: Respect Pygments background color
...
... except "classic" and "scrolls" themes.
2020-05-24 18:17:51 +02:00
Matthias Geier
d326f8cc7e
basic CSS: avoid unnecessary padding to the left of line numbers
2020-05-24 17:34:06 +02:00