Takeshi KOMIYA
73e99ab88b
Update CHANGES and docs for PR #7064
2020-03-05 20:40:35 +09:00
Daniel Hahler
58b39918fd
Use a string with warning in handle_signature
...
Previously it would pass in the exception object itself, which then
might crash filters that are using `record.msg.startswith` etc.
The warning was triggered for me with `sig = foo: int = -1`, where it
appears to not handle negative numbers (have not investigated).
2020-03-05 01:15:55 +01:00
Daniel Hahler
c5d42f3184
Remove unnecessary/missing "websupport" extra on CircleCI
2020-03-04 19:12:46 +01:00
Takeshi KOMIYA
2bec3f8cbd
Merge pull request #7248 from blueyed/tox-passenv-term
...
tox: passenv: add TERM
2020-03-05 01:30:05 +09:00
Daniel Hahler
933897c40b
tox: passenv: add TERM
...
tox is stupid to not include TERM by default
(https://github.com/tox-dev/tox/issues/1441 ).
This makes `tox -e docs` use proper progress indicators.
It splits `passenv` into a list to make diffs easier in the future.
Output from `tox -e docs` before:
```
Running Sphinx v4.0.0+/4633ab906
loading pickled environment... failed
failed: build environment version not current
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 77 source files that are out of date
updating environment: [new config] 77 added, 0 changed, 0 removed
reading sources... [ 1%] authors
reading sources... [ 2%] changes
reading sources... [ 3%] code_of_conduct
reading sources... [ 5%] contents
reading sources... [ 6%] develop
reading sources... [ 7%] development/tutorials/examples/README
reading sources... [ 9%] development/tutorials/helloworld
reading sources... [ 10%] development/tutorials/index
reading sources... [ 11%] development/tutorials/recipe
reading sources... [ 12%] development/tutorials/todo
reading sources... [ 14%] devguide
reading sources... [ 15%] examples
reading sources... [ 16%] extdev/appapi
reading sources... [ 18%] extdev/builderapi
reading sources... [ 19%] extdev/collectorapi
reading sources... [ 20%] extdev/deprecated
reading sources... [ 22%] extdev/domainapi
reading sources... [ 23%] extdev/envapi
reading sources... [ 24%] extdev/i18n
reading sources... [ 25%] extdev/index
reading sources... [ 27%] extdev/logging
reading sources... [ 28%] extdev/markupapi
reading sources... [ 29%] extdev/nodes
reading sources... [ 31%] extdev/parserapi
reading sources... [ 32%] extdev/projectapi
reading sources... [ 33%] extdev/utils
reading sources... [ 35%] faq
reading sources... [ 36%] glossary
reading sources... [ 37%] intro
reading sources... [ 38%] latex
reading sources... [ 40%] man/index
reading sources... [ 41%] man/sphinx-apidoc
reading sources... [ 42%] man/sphinx-autogen
reading sources... [ 44%] man/sphinx-build
reading sources... [ 45%] man/sphinx-quickstart
reading sources... [ 46%] templating
reading sources... [ 48%] theming
reading sources... [ 49%] usage/advanced/intl
reading sources... [ 50%] usage/advanced/setuptools
reading sources... [ 51%] usage/advanced/websupport/api
/tmp/tox/home/daniel/Vcs/sphinx/docs/lib/python3.8/site-packages/sphinxcontrib/websupport/__init__.py:18: RemovedInSphinx40Warning: sphinx.util.pycompat.htmlescape is deprecated. Check CHANGES for Sphinx API modifications.
from sphinxcontrib.websupport.core import WebSupport # NOQA
reading sources... [ 53%] usage/advanced/websupport/index
reading sources... [ 54%] usage/advanced/websupport/quickstart
reading sources... [ 55%] usage/advanced/websupport/searchadapters
reading sources... [ 57%] usage/advanced/websupport/storagebackends
reading sources... [ 58%] usage/builders/index
reading sources... [ 59%] usage/configuration
reading sources... [ 61%] usage/extensions/autodoc
reading sources... [ 62%] usage/extensions/autosectionlabel
reading sources... [ 63%] usage/extensions/autosummary
reading sources... [ 64%] usage/extensions/coverage
reading sources... [ 66%] usage/extensions/doctest
reading sources... [ 67%] usage/extensions/duration
reading sources... [ 68%] usage/extensions/example_google
reading sources... [ 70%] usage/extensions/example_numpy
reading sources... [ 71%] usage/extensions/extlinks
reading sources... [ 72%] usage/extensions/githubpages
reading sources... [ 74%] usage/extensions/graphviz
reading sources... [ 75%] usage/extensions/ifconfig
reading sources... [ 76%] usage/extensions/imgconverter
reading sources... [ 77%] usage/extensions/index
reading sources... [ 79%] usage/extensions/inheritance
reading sources... [ 80%] usage/extensions/intersphinx
reading sources... [ 81%] usage/extensions/linkcode
reading sources... [ 83%] usage/extensions/math
reading sources... [ 84%] usage/extensions/napoleon
reading sources... [ 85%] usage/extensions/todo
reading sources... [ 87%] usage/extensions/viewcode
reading sources... [ 88%] usage/installation
reading sources... [ 89%] usage/markdown
reading sources... [ 90%] usage/quickstart
reading sources... [ 92%] usage/restructuredtext/basics
reading sources... [ 93%] usage/restructuredtext/directives
reading sources... [ 94%] usage/restructuredtext/domains
reading sources... [ 96%] usage/restructuredtext/field-lists
reading sources... [ 97%] usage/restructuredtext/index
reading sources... [ 98%] usage/restructuredtext/roles
reading sources... [100%] usage/theming
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 1%] authors
writing output... [ 2%] changes
writing output... [ 3%] code_of_conduct
writing output... [ 5%] contents
writing output... [ 6%] develop
writing output... [ 7%] development/tutorials/examples/README
writing output... [ 9%] development/tutorials/helloworld
writing output... [ 10%] development/tutorials/index
writing output... [ 11%] development/tutorials/recipe
writing output... [ 12%] development/tutorials/todo
writing output... [ 14%] devguide
writing output... [ 15%] examples
writing output... [ 16%] extdev/appapi
writing output... [ 18%] extdev/builderapi
writing output... [ 19%] extdev/collectorapi
writing output... [ 20%] extdev/deprecated
writing output... [ 22%] extdev/domainapi
writing output... [ 23%] extdev/envapi
writing output... [ 24%] extdev/i18n
writing output... [ 25%] extdev/index
writing output... [ 27%] extdev/logging
writing output... [ 28%] extdev/markupapi
writing output... [ 29%] extdev/nodes
writing output... [ 31%] extdev/parserapi
writing output... [ 32%] extdev/projectapi
writing output... [ 33%] extdev/utils
writing output... [ 35%] faq
writing output... [ 36%] glossary
writing output... [ 37%] intro
writing output... [ 38%] latex
writing output... [ 40%] man/index
writing output... [ 41%] man/sphinx-apidoc
writing output... [ 42%] man/sphinx-autogen
writing output... [ 44%] man/sphinx-build
writing output... [ 45%] man/sphinx-quickstart
writing output... [ 46%] templating
writing output... [ 48%] theming
writing output... [ 49%] usage/advanced/intl
writing output... [ 50%] usage/advanced/setuptools
writing output... [ 51%] usage/advanced/websupport/api
writing output... [ 53%] usage/advanced/websupport/index
writing output... [ 54%] usage/advanced/websupport/quickstart
writing output... [ 55%] usage/advanced/websupport/searchadapters
writing output... [ 57%] usage/advanced/websupport/storagebackends
writing output... [ 58%] usage/builders/index
writing output... [ 59%] usage/configuration
writing output... [ 61%] usage/extensions/autodoc
writing output... [ 62%] usage/extensions/autosectionlabel
writing output... [ 63%] usage/extensions/autosummary
writing output... [ 64%] usage/extensions/coverage
writing output... [ 66%] usage/extensions/doctest
writing output... [ 67%] usage/extensions/duration
writing output... [ 68%] usage/extensions/example_google
writing output... [ 70%] usage/extensions/example_numpy
writing output... [ 71%] usage/extensions/extlinks
writing output... [ 72%] usage/extensions/githubpages
writing output... [ 74%] usage/extensions/graphviz
writing output... [ 75%] usage/extensions/ifconfig
writing output... [ 76%] usage/extensions/imgconverter
writing output... [ 77%] usage/extensions/index
writing output... [ 79%] usage/extensions/inheritance
writing output... [ 80%] usage/extensions/intersphinx
writing output... [ 81%] usage/extensions/linkcode
writing output... [ 83%] usage/extensions/math
writing output... [ 84%] usage/extensions/napoleon
writing output... [ 85%] usage/extensions/todo
writing output... [ 87%] usage/extensions/viewcode
writing output... [ 88%] usage/installation
writing output... [ 89%] usage/markdown
writing output... [ 90%] usage/quickstart
writing output... [ 92%] usage/restructuredtext/basics
writing output... [ 93%] usage/restructuredtext/directives
writing output... [ 94%] usage/restructuredtext/domains
writing output... [ 96%] usage/restructuredtext/field-lists
writing output... [ 97%] usage/restructuredtext/index
writing output... [ 98%] usage/restructuredtext/roles
writing output... [100%] usage/theming
generating indices... genindex py-modindexdone
highlighting module code... [ 2%] docutils.parsers.rst
highlighting module code... [ 4%] logging
highlighting module code... [ 7%] sphinx.addnodes
highlighting module code... [ 9%] sphinx.application
highlighting module code... [ 11%] sphinx.builders
highlighting module code... [ 14%] sphinx.builders.changes
highlighting module code... [ 16%] sphinx.builders.dirhtml
highlighting module code... [ 19%] sphinx.builders.dummy
highlighting module code... [ 21%] sphinx.builders.epub3
highlighting module code... [ 23%] sphinx.builders.gettext
highlighting module code... [ 26%] sphinx.builders.html
highlighting module code... [ 28%] sphinx.builders.latex
highlighting module code... [ 30%] sphinx.builders.linkcheck
highlighting module code... [ 33%] sphinx.builders.manpage
highlighting module code... [ 35%] sphinx.builders.singlehtml
highlighting module code... [ 38%] sphinx.builders.texinfo
highlighting module code... [ 40%] sphinx.builders.text
highlighting module code... [ 42%] sphinx.builders.xml
highlighting module code... [ 45%] sphinx.config
highlighting module code... [ 47%] sphinx.domains
highlighting module code... [ 50%] sphinx.environment
highlighting module code... [ 52%] sphinx.environment.collectors
highlighting module code... [ 54%] sphinx.errors
highlighting module code... [ 57%] sphinx.events
highlighting module code... [ 59%] sphinx.ext.autodoc
highlighting module code... [ 61%] sphinx.ext.coverage
highlighting module code... [ 64%] sphinx.locale
highlighting module code... [ 66%] sphinx.parsers
highlighting module code... [ 69%] sphinx.project
highlighting module code... [ 71%] sphinx.transforms
highlighting module code... [ 73%] sphinx.transforms.post_transforms
highlighting module code... [ 76%] sphinx.transforms.post_transforms.images
highlighting module code... [ 78%] sphinx.util.docutils
highlighting module code... [ 80%] sphinx.util.logging
highlighting module code... [ 83%] sphinxcontrib.applehelp
highlighting module code... [ 85%] sphinxcontrib.devhelp
highlighting module code... [ 88%] sphinxcontrib.htmlhelp
highlighting module code... [ 90%] sphinxcontrib.qthelp
highlighting module code... [ 92%] sphinxcontrib.serializinghtml
highlighting module code... [ 95%] sphinxcontrib.websupport.core
highlighting module code... [ 97%] sphinxcontrib.websupport.search
highlighting module code... [100%] sphinxcontrib.websupport.storage
writing additional pages... index search opensearchdone
copying images... [ 7%] _static/translation.png
copying images... [ 15%] _static/more.png
copying images... [ 23%] _static/themes/alabaster.png
copying images... [ 30%] _static/themes/classic.png
copying images... [ 38%] _static/themes/sphinxdoc.png
copying images... [ 46%] _static/themes/scrolls.png
copying images... [ 53%] _static/themes/agogo.png
copying images... [ 61%] _static/themes/traditional.png
copying images... [ 69%] _static/themes/nature.png
copying images... [ 76%] _static/themes/haiku.png
copying images... [ 84%] _static/themes/pyramid.png
copying images... [ 92%] _static/themes/bizstyle.png
copying images... [100%] _static/themes/sphinx_rtd_theme.png
copying downloadable files... [ 50%] usage/extensions/example_google.py
copying downloadable files... [100%] usage/extensions/example_numpy.py
copying static files... ... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.
```
After:
```
Running Sphinx v2.4.3
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 5 changed, 0 removed
/tmp/tox/home/daniel/Vcs/sphinx/docs/lib/python3.8/site-packages/sphinxcontrib/websupport/__init__.py:18: RemovedInSphinx40Warning: sphinx.util.pycompat.htmlescape is deprecated. Check CHANGES for Sphinx API modifications.
from sphinxcontrib.websupport.core import WebSupport # NOQA
reading sources... [100%] usage/builders/index
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] usage/builders/index
generating indices... genindex py-modindexdone
highlighting module code... [100%] sphinxcontrib.websupport.storage
writing additional pages... index search opensearchdone
copying downloadable files... [100%] usage/extensions/example_numpy.py
copying static files... ... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.
The HTML pages are in build/sphinx/html.
```
2020-03-03 23:12:19 +01:00
Takeshi KOMIYA
8dd83a540e
Merge pull request #7244 from tk0miya/refactor_type_annotation2
...
refactor: Update type annotation for python domain
2020-03-04 00:42:18 +09:00
Takeshi KOMIYA
d40997a29d
Merge pull request #7240 from tk0miya/7165_Annotated
...
Close #7165 : autodoc: Support Annotated type (PEP-593)
2020-03-04 00:24:28 +09:00
Takeshi KOMIYA
728c6cb5ee
refactor: Update type annotation for python domain
2020-03-04 00:24:08 +09:00
Takeshi KOMIYA
34057601f4
Close #7165 : autodoc: Support Annotated type (PEP-593)
2020-03-03 00:14:24 +09:00
Takeshi KOMIYA
cdc7cc6fb3
Merge pull request #7237 from tk0miya/refactor_std_domain2
...
std domain: Generate node_id for generic objects and targets in the right way
2020-03-03 00:11:57 +09:00
Takeshi KOMIYA
dfb2d6407e
std domain: Generate node_id for targets in the right way
2020-03-02 01:28:01 +09:00
Takeshi KOMIYA
fbfaf41e83
std domain: Generate node_id for generic objects in the right way
2020-03-02 01:28:01 +09:00
Takeshi KOMIYA
cd15ab658f
Merge pull request #7235 from tk0miya/7226_refactor
...
refactor: Sorting index entries
2020-03-01 22:53:56 +09:00
Takeshi KOMIYA
99dd7b3b42
refactor: Sorting index entries
2020-03-01 22:44:42 +09:00
Takeshi KOMIYA
95b98d97d5
test: clean up
2020-03-01 17:44:10 +09:00
Takeshi KOMIYA
3378cae82f
Update CHANGES for PR #7103
2020-03-01 17:43:55 +09:00
Takeshi KOMIYA
64d51a17aa
Merge pull request #7103 from westurner/linkcheck_json_output
...
ENH: linkcheck: also write all links to output.json
2020-03-01 17:43:03 +09:00
Takeshi KOMIYA
b892d195bf
Merge pull request #7229 from tk0miya/refactor_rst_domain
...
rst domain: Generate node_id for objects in the right way
2020-03-01 11:06:27 +09:00
Takeshi KOMIYA
7ebf6c22ab
Merge pull request #7232 from tk0miya/refactor_js_domain
...
refactor: js domain: Change make_old_*_id() to methods
2020-03-01 10:53:35 +09:00
Takeshi KOMIYA
ff4352e794
rst domain: Generate node_id for objects in the right way
2020-03-01 10:53:08 +09:00
Takeshi KOMIYA
dfaff26688
Merge pull request #7226 from tk0miya/7220_main_indexentries
...
Fix #7220 : genindex: "main" index entries are not shown at first
2020-03-01 02:14:18 +09:00
Takeshi KOMIYA
c84f7bfd57
Merge branch '2.x' into 3.x
2020-03-01 02:13:36 +09:00
Takeshi KOMIYA
9498dbeb30
Merge branch '2.4.x' into 2.x
2020-03-01 02:12:34 +09:00
Takeshi KOMIYA
0ef797ff65
refactor: js domain: Change make_old_*_id() to methods
2020-03-01 02:10:46 +09:00
Takeshi KOMIYA
e3c8e88132
Merge branch '3.x' into 7220_main_indexentries
2020-03-01 02:02:12 +09:00
Takeshi KOMIYA
42777588ed
Merge pull request #7224 from tk0miya/7223_slow_builds
...
Fix #7223 : Sphinx builds has been slower since 2.4.0
2020-03-01 01:55:37 +09:00
Takeshi KOMIYA
201455900a
Merge pull request #7210 from tk0miya/refactor_js_domain2
...
js domain: Generate node_id in the right way
2020-03-01 01:54:52 +09:00
Takeshi KOMIYA
dd8088f5aa
Update CHANGES
2020-03-01 01:46:18 +09:00
Takeshi KOMIYA
8f647643fb
js domain: Generate node_id for objects in the right way
2020-03-01 01:46:18 +09:00
Takeshi KOMIYA
9ba0cdf3bf
js domain: Show better duplication warning message
2020-03-01 01:46:18 +09:00
Takeshi KOMIYA
bdeb816397
js domain: Generate node_id for modules in the right way
2020-03-01 01:46:18 +09:00
Takeshi KOMIYA
f965829cd0
refactor: Do not evaluate debug message on calling
2020-02-29 23:20:34 +09:00
Takeshi KOMIYA
bac5192838
Update CHANGES for PR #7221
2020-02-29 23:17:09 +09:00
Takeshi KOMIYA
c67dfef221
Merge pull request #7221 from oxnz/3.x
...
Latex: replace polyglossia with babel for zh
2020-02-29 23:14:48 +09:00
Takeshi KOMIYA
0132aa527f
Close #7220 : genindex: Show "main" index entries at first
2020-02-29 18:51:09 +09:00
Takeshi KOMIYA
e6dc20b95d
Merge pull request #7231 from tk0miya/refactor_py_domain
...
Add testcase for modindex_common_prefix
2020-02-29 18:46:39 +09:00
Takeshi KOMIYA
0465c1a7ad
Add testcase for modindex_common_prefix
2020-02-29 18:23:58 +09:00
Takeshi KOMIYA
093d24ede0
Merge pull request #7228 from tk0miya/set_source_info_to_nodes
...
refactor: Set source_info to nodes
2020-02-29 17:16:50 +09:00
Takeshi KOMIYA
de52e77bc0
refactor: Set source_info to nodes
2020-02-29 17:00:58 +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
Takeshi KOMIYA
5330172d54
Fix #7223 : Sphinx builds has been slower since 2.4.0
2020-02-29 12:24:34 +09:00
Terence D. Honles
90de551d4c
Fix: autodoc: __wrapped__ functions are not documented correctly
...
Functions that are decorated with `@lru_cache` or other `functools`
decorators may not even be detected as a function. This results in the
documentation not having the `()` or even trying to render the function
signature.
This change updates the `sphinx.util.inspect` code to unwrap
`__wrapped__` functions before determining if they can be documented.
`@lru_cache` and its associated test is an example of a decorated
function that is incorrectly identified as an attribute rather than a
module level function and when rendering the signature (upon changing
`isattributedescriptor`) the decorated function is still incorrectly
identified as a C function.
This change also renames the newly introduced `unwrap` as `unwrap_all`
because it is different than the prexisting Python supplied
`inspect.unwrap`.
See `update_wrapper` "Changed in version 3.4" for more background:
https://docs.python.org/3/library/functools.html#functools.update_wrapper
2020-02-27 16:27:41 -08:00
Will D. Thomas
ba77af2641
Latex: replace polyglossia with babel for zh
...
polyglossia does not compatible with xeCJK.
it would override all Chinese font with Serif family.
2020-02-27 21:50:18 +08:00
Jean-François B
942dbc6be6
Merge pull request #7205 from jfbu/latex_7197
...
LaTeX, fix \sphinxhref + \includegraphics problem with platex
2020-02-26 09:16:33 +01:00
Tetsuo Koyama
89490287e7
🆕 docker-sphinx
...
Co-authored-by: tk0miya <i.tkomiya@gmail.com>
2020-02-25 12:47:14 +09:00
Takeshi KOMIYA
8cfea7bedd
Merge pull request #7213 from tk0miya/bump_docker
...
Add a procedure to update docker image
2020-02-25 01:32:06 +09:00
Takeshi KOMIYA
510bd13a9b
Merge pull request #7214 from tk0miya/update_docs
...
Update docs
2020-02-25 01:31:04 +09:00
Tetsuo Koyama
e20430aee1
🆕 docker-sphinx
2020-02-24 16:04:53 +09:00
