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

Docs - replace python with python3 for intersphinx #2429

Closed
stevepiercy opened this issue Apr 5, 2016 · 10 comments
Closed

Docs - replace python with python3 for intersphinx #2429

stevepiercy opened this issue Apr 5, 2016 · 10 comments
Assignees
Milestone

Comments

@stevepiercy
Copy link
Member

Our intersphinx links and many other links to Python docs point to version 2.x, e.g.,

:ref:`Python Packages <python:tut-packages>`

We should be using this:

:ref:`Python Packages <python3:tut-packages>`

...where we edit docs/conf.py to generate intersphinx links to the Python 3.x docs concurrently with Python 2:

    'python': (
        'http://docs.python.org/2',
        None),
    'python3': (
        'https://docs.python.org/3/',
        None),

Some links might change between Python 2 and 3, so each rendered link needs to be tested.

Assuming all links to Python 2 can be changed to 3, then docs/conf.py can drop the intersphinx entry for 'python' as the final step of this task.

I'm already doing this for the branch docs/easy-install-to-pip.2104 and issue #2223, but there are other docs that are outside the scope of that branch/issue that will also need review.

@stevepiercy stevepiercy self-assigned this Apr 5, 2016
@stevepiercy stevepiercy added this to the 1.7 milestone Apr 5, 2016
stevepiercy added a commit to stevepiercy/pyramid that referenced this issue Apr 5, 2016
- add python3 for intersphinx. See Pylons#2429
- minor grammar
@mmerickel
Copy link
Member

I would just re-alias python to python3's url and add a python2 if anything needs to ref py2 explicitly.

@stevepiercy
Copy link
Member Author

When I did this:

 'python': (
        'https://docs.python.org/3',
        None),

and

:ref:`Python Packages <python:tut-packages>`

Links still pointed at Python 2 docs. I even blasted away the build directory. Do you mean something else?

@mmerickel
Copy link
Member

That seems like something is still sticking around for whatever reason.

@mmerickel
Copy link
Member

@stevepiercy don't start tagging this pip work on the 1.7 milestone unless you're positive it's getting done in the next few weeks.

@mmerickel mmerickel removed this from the 1.7 milestone Apr 5, 2016
@stevepiercy stevepiercy added this to the 1.7 milestone Apr 5, 2016
@stevepiercy
Copy link
Member Author

Unless something untoward should happen to me, it will.

@stevepiercy
Copy link
Member Author

I couldn't figure out why things stuck around. Were you able to replicate the issue? Could it be some obscure default in intersphinx?

@mmerickel
Copy link
Member

I'm pretty anti changing every reference in the doc to python3: so if we can't figure this out then I opt to keeping things at python2 until we can. Version-specific directives are a pain to maintain.

@stevepiercy
Copy link
Member Author

Were you able to replicate the issue? I'd like to know if it's just my setup. If you can replicate it, then I'll try a clean virtualenv to eliminate any possible stickiness.

@stevepiercy
Copy link
Member Author

It was me. There's a stray docs/quick_tutorial/conf.py and I thought I was editing docs/conf.py. argh.

stevepiercy added a commit to stevepiercy/pyramid that referenced this issue Apr 6, 2016
- update intersphinx link to python3 docs
- Closes Pylons#2429
@stevepiercy
Copy link
Member Author

Closed by #2431

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

No branches or pull requests

2 participants