Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: Move the module declaration to index.rst #8280

Merged
merged 1 commit into from Jan 27, 2021

Conversation

xuhdev
Copy link
Contributor

@xuhdev xuhdev commented Jan 26, 2021

When the declaration stays in reference.rst, it creates duplicated
"pytest" symbols such as pytest.pytest.mark.filterwarnings.

Resolves #8220 (comment)

When the declaration stays in reference.rst, it creates duplicated
"pytest" symbols such as `pytest.pytest.mark.filterwarnings`.
@xuhdev
Copy link
Contributor Author

xuhdev commented Jan 26, 2021

❯ python3 -m sphinx.ext.intersphinx https://pytest--8280.org.readthedocs.build/en/8280/objects.inv | rg -e '^py' -e '\.mark\.'
pytest/git/module 
py:attribute
py:class
py:exception
py:function
        pytest.mark.filterwarnings               reference.html#pytest.mark.filterwarnings
        pytest.mark.skip                         reference.html#pytest.mark.skip
        pytest.mark.skipif                       reference.html#pytest.mark.skipif
        pytest.mark.usefixtures                  reference.html#pytest.mark.usefixtures
        pytest.mark.xfail                        reference.html#pytest.mark.xfail
py:method
py:module
        @pytest.mark.parametrize                 @pytest.mark.parametrize: parametrizing test functions: parametrize.html#pytest-mark-parametrize
        filterwarnings                           @pytest.mark.filterwarnings             : warnings.html#filterwarnings
        parametrizemark                          @pytest.mark.parametrize: parametrizing test functions: parametrize.html#parametrizemark
        pytest.mark.filterwarnings ref           pytest.mark.filterwarnings              : reference.html#pytest-mark-filterwarnings-ref
        pytest.mark.parametrize ref              pytest.mark.parametrize                 : reference.html#pytest-mark-parametrize-ref
        pytest.mark.skip ref                     pytest.mark.skip                        : reference.html#pytest-mark-skip-ref
        pytest.mark.skipif ref                   pytest.mark.skipif                      : reference.html#pytest-mark-skipif-ref
        pytest.mark.usefixtures ref              pytest.mark.usefixtures                 : reference.html#pytest-mark-usefixtures-ref
        pytest.mark.xfail ref                    pytest.mark.xfail                       : reference.html#pytest-mark-xfail-ref

@xuhdev xuhdev mentioned this pull request Jan 26, 2021
@QuLogic
Copy link

QuLogic commented Jan 26, 2021

PS, when this is merged, can docs be rebuilt with it ASAP? It is currently breaking docs ci for Matplotlib.

@xuhdev
Copy link
Contributor Author

xuhdev commented Jan 26, 2021

@QuLogic I think the doc is automatically built every time a new commit is pushed to master

@nicoddemus
Copy link
Member

Thanks a lot @xuhdev!

For the reference, here are the references in latest:

λ python -m sphinx.ext.intersphinx https://docs.pytest.org/en/latest/objects.inv | rg -e "^py" -e "\.mark\."
py:attribute
py:class
py:exception
py:function
        pytest.pytest.mark.filterwarnings        reference.html#pytest.pytest.mark.filterwarnings
        pytest.pytest.mark.skip                  reference.html#pytest.pytest.mark.skip
        pytest.pytest.mark.skipif                reference.html#pytest.pytest.mark.skipif
        pytest.pytest.mark.usefixtures           reference.html#pytest.pytest.mark.usefixtures
        pytest.pytest.mark.xfail                 reference.html#pytest.pytest.mark.xfail
py:method
py:module
        @pytest.mark.parametrize                 @pytest.mark.parametrize: parametrizing test functions: parametrize.html#pytest-mark-parametrize
        filterwarnings                           @pytest.mark.filterwarnings             : warnings.html#filterwarnings
        parametrizemark                          @pytest.mark.parametrize: parametrizing test functions: parametrize.html#parametrizemark
        pytest.mark.filterwarnings ref           pytest.mark.filterwarnings              : reference.html#pytest-mark-filterwarnings-ref
        pytest.mark.parametrize ref              pytest.mark.parametrize                 : reference.html#pytest-mark-parametrize-ref
        pytest.mark.skip ref                     pytest.mark.skip                        : reference.html#pytest-mark-skip-ref
        pytest.mark.skipif ref                   pytest.mark.skipif                      : reference.html#pytest-mark-skipif-ref
        pytest.mark.usefixtures ref              pytest.mark.usefixtures                 : reference.html#pytest-mark-usefixtures-ref
        pytest.mark.xfail ref                    pytest.mark.xfail                       : reference.html#pytest-mark-xfail-ref

@nicoddemus nicoddemus added the needs backport applied to PRs, indicates that it should be ported to the current bug-fix branch label Jan 27, 2021
@nicoddemus nicoddemus merged commit 0365b1b into pytest-dev:master Jan 27, 2021
nicoddemus added a commit to nicoddemus/pytest that referenced this pull request Jan 27, 2021
Doc: Move the module declaration to index.rst
@nicoddemus
Copy link
Member

Backport: #8285

@nicoddemus nicoddemus added backported PR has been backported to the current bug-fix branch and removed needs backport applied to PRs, indicates that it should be ported to the current bug-fix branch labels Jan 27, 2021
@QuLogic
Copy link

QuLogic commented Jan 27, 2021

Will this end up in /stable soon or should we point Matplotlib's doc builds at /latest?

@nicoddemus
Copy link
Member

nicoddemus commented Jan 28, 2021

It will take a few weeks unfortunately, stable points to the latest tag (6.2.2), not the last commit on the "stable" branch (6.2.x).

But I believe for the purpose of referencing the docs, /latest might be good enough for Matplotlib's referencing of pytest's docs, at least while we don't make a new release.

QuLogic added a commit to QuLogic/matplotlib that referenced this pull request Jan 28, 2021
This is fixed in pytest git, but won't be in a released version for some
time.
pytest-dev/pytest#8280 (comment)
QuLogic added a commit to QuLogic/matplotlib that referenced this pull request Jan 28, 2021
The incorrect reference is fixed in pytest git, but won't be in a
released version for some time.
pytest-dev/pytest#8280 (comment)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backported PR has been backported to the current bug-fix branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants