Skip to content

Use sphinx removed in extension in the documentation#4570

Merged
nicoddemus merged 2 commits into
pytest-dev:masterfrom
nicoddemus:sphinx-removed-in
Jan 12, 2019
Merged

Use sphinx removed in extension in the documentation#4570
nicoddemus merged 2 commits into
pytest-dev:masterfrom
nicoddemus:sphinx-removed-in

Conversation

@nicoddemus

@nicoddemus nicoddemus commented Dec 20, 2018

Copy link
Copy Markdown
Member

Fix #4568

This is blocked by MrSenko/sphinx-removed-in#1:


λ tox -re docs
docs create: C:\Users\bruno\pytest\.tox\docs
docs installdeps: -rC:\Users\bruno\pytest/doc/en/requirements.txt
ERROR: invocation failed (exit code 1), logfile: C:\Users\bruno\pytest\.tox\docs\log\docs-1.log
ERROR: actionid: docs
msg: getenv
cmdargs: "'C:\\Users\\bruno\\pytest\\.tox\\docs\\Scripts\\python.EXE' -m pip install '-rC:\\Users\\bruno\\pytest/doc/en/requirements.txt'"

Collecting pygments-pytest>=1.1.0 (from -r C:\Users\bruno\pytest/doc/en/requirements.txt (line 1))
  Using cached https://files.pythonhosted.org/packages/49/3e/fc3a0102c4ae97430d34303c0963cc779e8a1c74a73fe6a04539665fdbb0/pygments_pytest-1.1.0-py2.py3-none-any.whl
Collecting sphinx>=1.8.2 (from -r C:\Users\bruno\pytest/doc/en/requirements.txt (line 2))
  Using cached https://files.pythonhosted.org/packages/ff/d5/3a8727d6f890b1ae45da72a55bf8449e9f2c535a444923b338c3f509f203/Sphinx-1.8.2-py2.py3-none-any.whl
Collecting sphinxcontrib-trio (from -r C:\Users\bruno\pytest/doc/en/requirements.txt (line 3))
  Using cached https://files.pythonhosted.org/packages/09/28/70870892f814a46db677872ba8da59936601d00f1109dc9359b122d3a8fc/sphinxcontrib_trio-1.0.1-py3-none-any.whl
Collecting sphinx-removed-in (from -r C:\Users\bruno\pytest/doc/en/requirements.txt (line 4))
  Using cached https://files.pythonhosted.org/packages/74/04/b6bcf18ddf8ac127b9f0c5dffd20542fdcfbf3db6b689947217bd46f4980/sphinx-removed-in-0.1.0.tar.gz
    Complete output from command python setup.py egg_info:
    Traceback (most recent call last):
      File "<string>", line 1, in <module>
      File "C:\Users\bruno\AppData\Local\Temp\pip-install-sqas3ip2\sphinx-removed-in\setup.py", line 5, in <module>
        __version__ = __import__('sphinx_removed_in').__version__
      File "C:\Users\bruno\AppData\Local\Temp\pip-install-sqas3ip2\sphinx-removed-in\sphinx_removed_in\__init__.py", line 1, in <module>
        from sphinx.locale import versionlabels
    ModuleNotFoundError: No module named 'sphinx'

@codecov

codecov Bot commented Dec 20, 2018

Copy link
Copy Markdown

Codecov Report

Merging #4570 into features will decrease coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##           features    #4570      +/-   ##
============================================
- Coverage     95.75%   95.73%   -0.02%     
============================================
  Files           111      111              
  Lines         24671    24671              
  Branches       2445     2445              
============================================
- Hits          23623    23620       -3     
  Misses          740      740              
- Partials        308      311       +3
Flag Coverage Δ
#docs 29.58% <ø> (+0.07%) ⬆️
#doctesting 29.58% <ø> (+0.07%) ⬆️
#linting 29.58% <ø> (+0.07%) ⬆️
#linux 95.56% <ø> (ø) ⬆️
#nobyte 92.37% <ø> (ø) ⬆️
#numpy 93.17% <ø> (-0.02%) ⬇️
#pexpect 42.11% <ø> (-0.03%) ⬇️
#py27 93.75% <ø> (-0.04%) ⬇️
#py34 91.86% <ø> (+0.06%) ⬆️
#py35 91.88% <ø> (+0.06%) ⬆️
#py36 91.9% <ø> (+0.06%) ⬆️
#py37 93.92% <ø> (ø) ⬆️
#trial 93.17% <ø> (-0.02%) ⬇️
#windows 93.92% <ø> (-0.02%) ⬇️
#xdist 93.77% <ø> (-0.02%) ⬇️
Impacted Files Coverage Δ
src/_pytest/cacheprovider.py 95.75% <0%> (-1.42%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1a9979a...81c2780. Read the comment docs.

@nicoddemus

Copy link
Copy Markdown
Member Author

Hmmm same error even though MrSenko/sphinx-removed-in#1 has been fixed and we are using 0.1.1. I also checked the PyPI package and it contains the correct setup_requires keyword parameter... any ideas @RonnyPfannschmidt?

@RonnyPfannschmidt

Copy link
Copy Markdown
Member

@nicoddemus setup_requires happens too late to work out sanely there, aka its evaluated after that import happens

@nicoddemus

Copy link
Copy Markdown
Member Author

Duh of course.

I suppose the simplest fix would be to stop importing sphinx at the top-level of sphinx_removed_in.

cc @MrSenko

nicoddemus added a commit to nicoddemus/sphinx-removed-in that referenced this pull request Dec 20, 2018
Follow up to MrSenko#1: unfortunately `setup_requires` is not enough to fix the original issue, as `setup_requires` can't be evaluated yet (ref: pytest-dev/pytest#4570 (comment)).
@nicoddemus

Copy link
Copy Markdown
Member Author

atodorov pushed a commit to MrSenko/sphinx-removed-in that referenced this pull request Dec 21, 2018
Follow up to #1: unfortunately `setup_requires` is not enough to fix the original issue, as `setup_requires` can't be evaluated yet (ref: pytest-dev/pytest#4570 (comment)).
@nicoddemus

Copy link
Copy Markdown
Member Author

Comment thread doc/en/deprecations.rst

This has been documented as deprecated for years, but only now we are actually emitting deprecation warnings.

``Node.get_marker``

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved those two deprecations to near the other ones from 4.0.

Comment thread doc/en/requirements.txt
pygments-pytest>=1.1.0
sphinx>=1.8.2
sphinxcontrib-trio
sphinx-removed-in>=0.1.3

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@atodorov thanks again! 👍

@nicoddemus nicoddemus changed the title [WIP] Use sphinx removed in extension in the documentation Use sphinx removed in extension in the documentation Jan 2, 2019
@nicoddemus

Copy link
Copy Markdown
Member Author

Ready for review. 👍

@Tadaboody

Tadaboody commented Jan 3, 2019

Copy link
Copy Markdown
Contributor

Is there a way to see the compiled docs online for the review? (other than checking it out and building locally that is)

@RonnyPfannschmidt

Copy link
Copy Markdown
Member

@nicoddemus can we push this branch to the main repo so we can trigger a rtd build?

@nicoddemus

Copy link
Copy Markdown
Member Author

Hmm I did a few hours ago and I still don't see it listed under the "versions" option. Weird. 🤔

@nicoddemus

Copy link
Copy Markdown
Member Author

@nicoddemus nicoddemus changed the base branch from features to master January 8, 2019 01:05
@nicoddemus

Copy link
Copy Markdown
Member Author

Targetting master now. 👍

@RonnyPfannschmidt RonnyPfannschmidt left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lovely, thanks

@nicoddemus

Copy link
Copy Markdown
Member Author

@Tadaboody gentle ping. 😁

@nicoddemus nicoddemus merged commit 25081d8 into pytest-dev:master Jan 12, 2019
@nicoddemus nicoddemus deleted the sphinx-removed-in branch January 12, 2019 10:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants