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

Fix sphinx intersphinx_mapping config. #1439

Merged
merged 1 commit into from
May 9, 2023

Conversation

jctanner
Copy link
Contributor

@jctanner jctanner commented May 8, 2023

# make PULP_URL="$PULP_URL" html
sphinx-build -b html -d _build/doctrees  -W -n . _build/html
Running Sphinx v7.0.0

Warning, treated as error:
Failed to read intersphinx_mapping[https://docs.python.org/], ignored: SphinxWarning('The pre-Sphinx 1.0 \'intersphinx_mapping\' format is deprecated and will be removed in Sphinx 8. Update to the current format as described in the documentation. Hint: "intersphinx_mapping = {\'<name>\': (\'https://docs.python.org/\', None)}".https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_mapping')
make: *** [Makefile:63: html] Error 2

New value comes from https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration

[noissue]

@mdellweg mdellweg merged commit ee877c0 into pulp:main May 9, 2023
@patchback
Copy link

patchback bot commented May 9, 2023

Backport to 0.17: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply ee877c0 on top of patchback/backports/0.17/ee877c0a92f2ba9e3a69dd2ad515afd9e3a4d3fc/pr-1439

Backporting merged PR #1439 into main

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git remote add upstream https://github.com/pulp/pulp_ansible.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/0.17/ee877c0a92f2ba9e3a69dd2ad515afd9e3a4d3fc/pr-1439 upstream/0.17
  4. Now, cherry-pick PR Fix sphinx intersphinx_mapping config. #1439 contents into that branch:
    $ git cherry-pick -x ee877c0a92f2ba9e3a69dd2ad515afd9e3a4d3fc
    If it'll yell at you with something like fatal: Commit ee877c0a92f2ba9e3a69dd2ad515afd9e3a4d3fc is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x ee877c0a92f2ba9e3a69dd2ad515afd9e3a4d3fc
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Fix sphinx intersphinx_mapping config. #1439 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/0.17/ee877c0a92f2ba9e3a69dd2ad515afd9e3a4d3fc/pr-1439
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

@mdellweg
Copy link
Member

mdellweg commented May 9, 2023

This reminds me that i wanted to see if we can make the docs making more like in the other plugins...

jctanner added a commit to jctanner/pulp_ansible that referenced this pull request May 9, 2023
@jctanner
Copy link
Contributor Author

jctanner commented May 9, 2023

#1440

mdellweg pushed a commit that referenced this pull request May 9, 2023
mdellweg pushed a commit that referenced this pull request May 10, 2023
mdellweg pushed a commit that referenced this pull request May 10, 2023
…lidated data (#1442)

* Serializer.validate must return validated data. Fixes #1441 (#1432)

(cherry picked from commit 69e2017)

* Fix sphinx intersphinx_mapping config. (#1439)

New value comes from https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration

[noissue]

Signed-off-by: James Tanner <[email protected]>
(cherry picked from commit ee877c0)

---------

Co-authored-by: Matt Martz <[email protected]>
Co-authored-by: jctanner <[email protected]>
mdellweg pushed a commit that referenced this pull request May 10, 2023
mdellweg pushed a commit that referenced this pull request May 10, 2023
mdellweg pushed a commit that referenced this pull request May 10, 2023
mdellweg pushed a commit that referenced this pull request May 10, 2023
* Update CI files

[noissue]

* Fix sphinx intersphinx_mapping config. (#1439)

New value comes from https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration

[noissue]

Signed-off-by: James Tanner <[email protected]>
(cherry picked from commit ee877c0)

---------

Co-authored-by: jctanner <[email protected]>
mdellweg pushed a commit that referenced this pull request May 10, 2023
* Update CI files

[noissue]

* Fix sphinx intersphinx_mapping config. (#1439)

New value comes from https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration

[noissue]

Signed-off-by: James Tanner <[email protected]>
(cherry picked from commit ee877c0)

---------

Co-authored-by: jctanner <[email protected]>
mdellweg pushed a commit that referenced this pull request May 10, 2023
* Update CI files

[noissue]

* Fix sphinx intersphinx_mapping config. (#1439)

New value comes from https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration

[noissue]

Signed-off-by: James Tanner <[email protected]>
(cherry picked from commit ee877c0)

---------

Co-authored-by: jctanner <[email protected]>
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.

2 participants