Adam Turner
1f21e973d4
Use released Docutils 0.19 on CI
2022-07-06 19:18:10 +01:00
Adam Turner
68bc916cf4
Test with Docutils 0.19 prereleases ( #10598 )
2022-06-25 22:15:30 +01:00
Julien Palard
4a67ea1da3
doc linting: Re-enable a check ( #10573 )
2022-06-19 23:29:00 +01:00
Julien Palard
956cddb7d4
Replace doclinter with sphinx-lint ( #10389 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com >
2022-06-16 19:32:09 +01:00
Adam Turner
65ae948eca
Split out coverage
2022-05-02 17:47:46 +01:00
Adam Turner
3420d15cb9
Bump Docutils dependency
2022-04-19 03:09:45 +01:00
Takeshi KOMIYA
a0f5f240ea
Merge branch '5.x' into encoding-warnings
2022-04-17 13:10:08 +09:00
Adam Turner
26c5c40b50
Enable the opt-in EncodingWarning
...
https://docs.python.org/3/library/io.html#io-encoding-warning
2022-04-16 19:30:45 +01:00
Adam Turner
ec0c13c26d
Don't use deprecated setup.py build_sphinx
2022-04-16 19:08:27 +01:00
Takeshi KOMIYA
ab5b8dc9ee
CI: refactor tox.ini; Install HEAD of docutils directly
2022-01-08 22:57:31 +09:00
Takeshi KOMIYA
c16b36c499
CI: Remove unused no longer needed PYTHONWARNINGS
2022-01-02 15:03:20 +09:00
James Knight
334bdceeff
tox: support coverage on win32
...
When invoking the `coverage` on a Windows environment, the following
exception may generate:
...
raise CoverageException(f"Couldn't read {fname!r} as a config file")
coverage.exceptions.CoverageException: Couldn't read 'C:mycodesphinx/setup.cfg' as a config file
ERROR: InvocationError for command 'C:\mycode\sphinx\.tox\coverage\Scripts\python.EXE' -X dev -m pytest --durations 25 (exited with code 1)
Enclosing with configuration file with quotes can improve the handling
of a provided path on multiple platform types.
Signed-off-by: James Knight <james.d.knight@live.com >
2021-12-05 14:24:14 -05:00
Hugo van Kemenade
2d9c6db3ce
Remove py workaround
2021-11-05 13:14:42 +02:00
Takeshi KOMIYA
0f0b93df9e
Merge pull request #9702 from tk0miya/test_with_docutils-latest
...
test: Do test with the HEAD of docutils
2021-10-09 13:57:37 +09:00
Takeshi KOMIYA
5a79bafe85
CI: Install unreleased "py" package for 3.11-dev
2021-10-09 13:00:48 +09:00
Takeshi KOMIYA
f13ad80207
Support Python 3.10
2021-10-07 02:34:44 +09:00
Takeshi KOMIYA
6fc96f412a
test: Do test with the HEAD of docutils
2021-10-03 20:15:36 +09:00
Daniel Hahler
e89de152d8
ci(tox.ini): add COLORTERM to passenv
...
This is required for [kitty](https://sw.kovidgoyal.net/kitty/ ), which
uses TERM=xterm-kitty, which is not detected as being a colored
terminal, without its `COLORTERM=truecolor` also being passed [1].
1: d194e0f490/sphinx/util/console.py (L70-L71)
2021-08-30 10:32:30 +02:00
Takeshi KOMIYA
2308a2fffa
test: Test with the bugfixed version of each docutils release
2021-04-11 12:44:04 +09:00
Takeshi KOMIYA
41a377fee5
Merge branch '3.x'
2021-04-04 00:06:45 +09:00
Takeshi KOMIYA
cf2d11f947
test: Do test with docutils-0.17 (final)
2021-04-03 23:54:41 +09:00
Takeshi KOMIYA
26d0bb641b
test: Do test with docutils-0.17b1
2021-04-03 23:54:19 +09:00
Takeshi KOMIYA
62a0ee3fef
Merge branch '3.x'
2020-12-31 14:33:09 +09:00
Takeshi KOMIYA
f054b9b976
refactor: Reduce warnings on testing
2020-12-29 19:23:46 +09:00
Takeshi KOMIYA
279e547860
Merge branch '3.x'
2020-11-12 02:50:43 +09:00
Takeshi KOMIYA
64fb1e5624
Merge pull request #8411 from francoisfreitag/devmode
...
Run tests with Python Development mode
2020-11-12 02:20:43 +09:00
François Freitag
22a4ed531c
Run tests with Python Development mode
...
Helps catching more issues with the test suite.
https://docs.python.org/3/library/devmode.html#devmode
2020-11-11 14:20:18 +01:00
François Freitag
0949735210
Sort imports with isort
...
Keep imports alphabetically sorted and their order homogeneous across
Python source files.
The isort project has more feature and is more active than the
flake8-import-order plugin.
Most issues caught were simply import ordering from the same module.
Where imports were purposefully placed out of order, tag with
isort:skip.
2020-11-11 13:19:05 +01:00
Takeshi KOMIYA
8bf84167a3
Merge branch '3.x'
2020-11-05 02:21:47 +09:00
Takeshi KOMIYA
162a0048e5
tox.ini: Do not override $PYTEST_ADDOPTS forcedly
2020-11-05 01:05:36 +09:00
Takeshi KOMIYA
8412347f5d
Merge branch '3.x'
2020-08-14 14:28:58 +09:00
Takeshi KOMIYA
5f420a4d8f
Merge pull request #8090 from tk0miya/remove_pylint
...
Remove pylint task
2020-08-14 01:29:01 +09:00
harupy
2a632598c3
fix
2020-08-14 00:48:41 +09:00
harupy
2f971a61f3
Color pytest output log
2020-08-14 00:41:17 +09:00
Takeshi KOMIYA
6cf1301c9e
Remove pylint task
...
At present, pylint has no longer been used in this project. This
removes the tasks and files for pylint from repository.
2020-08-10 13:20:06 +09:00
Takeshi KOMIYA
70d521ad9c
Merge branch '3.x'
2020-07-11 21:59:58 +09:00
Takeshi KOMIYA
3d737ef2b7
test: Use released html5lib package
...
Recently, html5lib-1.1 was released. So it is no longer to install
it from repository.
2020-07-05 19:59:14 +09:00
Takeshi KOMIYA
ec3754bd94
Merge branch '3.x'
2020-07-05 01:32:54 +09:00
Takeshi KOMIYA
7167b689b9
Do "twine check" on CI process
2020-06-14 16:06:25 +09:00
Takeshi KOMIYA
c4321ce830
Drop CI settings for py35 and docutils-0.1[34]
2020-03-07 18:06:40 +09:00
Takeshi KOMIYA
09623a97d0
Merge branch '2.x' into 3.x
2020-03-05 23:11:14 +09:00
Takeshi KOMIYA
3e7b18e971
Unpin coverage package
...
coverage-5.0 expects to set "parallel = True" on config file.
refs: https://github.com/nedbat/coveragepy/issues/716#issuecomment-429491441
2020-03-05 22:38:47 +09: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
c09ff16a32
Clean up PYTHONWARNINGS
2020-02-16 22:23:46 +09:00
Wes Turner
b2b6d240a7
BLD: tox.ini: flake8: add whitelist_externals for latest tox instead of adding dep, pass posargs through
2020-02-10 17:25:54 -05:00
Takeshi KOMIYA
e7a0af807a
Merge branch '2.0'
2020-01-30 23:29:32 +09:00
Takeshi KOMIYA
f8fc6075ba
Merge pull request #7049 from tk0miya/test_with_docutils-0.16
...
Test with docutils-0.16
2020-01-23 23:48:40 +09:00
Takeshi KOMIYA
00a4c13d0b
Add new extras_require: lint
2020-01-23 01:42:33 +09:00
Takeshi KOMIYA
ee28dace61
Use HEAD of html5lib on testing with py39
2020-01-23 01:11:51 +09:00
