build: updating to sphinx<6.0.0 constraint. #199
Conversation
Codecov ReportBase: 100.00% // Head: 100.00% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## master #199 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 1 1
Lines 19 19
=========================================
Hits 19 19
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
| @@ -18,7 +18,7 @@ def html_dir(): | |||
| docs_path = os.path.join(os.path.abspath(os.path.dirname(__file__)), '..', 'docs') | |||
| build_path = os.path.join(docs_path, '_test', 'html') | |||
| os.chdir(docs_path) | |||
| result = build_main(['sphinx-build', '-b', 'html', '.', build_path]) | |||
| result = build_main(['-b', 'html', '.', build_path]) | |||
There was a problem hiding this comment.
There was a problem hiding this comment.
In older version it strips the first arg.
-> return build.build_main(argv[1:]) # skip first argument to adjust arguments (refs: #4615)
(Pdb) argv
['sphinx-build', '-b', 'html', '.', '/Users/awaisqureshi/Documents/devstack/edx-sphinx-theme/tests/../docs/_test/html']
(Pdb) argv[1:]
['-b', 'html', '.', '/Users/awaisqureshi/Documents/devstack/edx-sphinx-theme/tests/../docs/_test/html']
There was a problem hiding this comment.
In latest version first arg is not ignoring thats why it throws the error due to 'sphinx-build'
> /Users/awaisqureshi/.pyenv/versions/3.8.3/lib/python3.8/site-packages/sphinx/cmd/build.py(270)build_main()
-> args = _parse_arguments(argv)
(Pdb) sys.argv[1:]
[]
(Pdb) argv
['sphinx-build', '-b', 'html', '.', '/Users/awaisqureshi/Documents/devstack/edx-sphinx-theme/tests/../docs/_test/html']
(Pdb) n
awais786
changed the title
| @@ -15,7 +15,7 @@ jobs: | |||
| matrix: | |||
| os: [ubuntu-20.04] | |||
| python-version: ['3.8'] | |||
| toxenv: [sphinx11, sphinx14, docs, quality] | |||
| toxenv: [sphinx50, docs, quality] | |||
There was a problem hiding this comment.
There's one more reference to sphinx14.
This might need to be updated as well.
tox.ini
Outdated
| @@ -34,8 +34,7 @@ norecursedirs = .* docs requirements | |||
|
|
|||
| [testenv] | |||
| deps = | |||
| sphinx18: Sphinx==1.1.3 | |||
| django19: Sphinx>=1.4,<1.5 | |||
| Sphinx50: Sphinx>=5.0.0,<6.0.0 | |||
There was a problem hiding this comment.
The starting s of Sphinx50 would be in lowercase just like here
https://github.com/openedx/edx-sphinx-theme/pull/199/files#diff-b803fcb7f17ed9235f1e5cb1fcd2f5d3b2838429d4368ae4c57ce4436577f03fR18
| snowballstemmer==2.2.0 | ||
| # via sphinx | ||
| sphinx==1.8.5 | ||
| sphinx==5.3.0 |
awais786
force-pushed
the
upgrade-sphnix-
branch
from
5deea3a
to
d8d423a
Compare
awais786
force-pushed
the
upgrade-sphnix-
branch
from
d8d423a
to
314bf5a
Compare
Fix Sphinx version constraint found details here
Upgraded to
sphinx==5.3.06.0.0is not compatible with this theme thats why added a<6.0.0constraint here.In older versions they were ignoring first arg. But in new version they stopped ignoring. Thats why updated the command
build_main(['-b', 'html', '.', build_path])For details check the following PR
https://github.com/sphinx-doc/sphinx/pull/3668/files