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

Tiny docs ticket fixes #31

Closed
wants to merge 4 commits into from
Closed

Conversation

@tapaswenipathak
Copy link
Contributor

@tapaswenipathak tapaswenipathak commented Sep 2, 2019

Hey! Found few tiny issues in Python Docs Sphinx Theme I can help fix. Let me know if my PR helps in anyway, thank you.

@the-knights-who-say-ni
Copy link

@the-knights-who-say-ni the-knights-who-say-ni commented Sep 2, 2019

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA).

Our records indicate we have not received your CLA. For legal reasons we need you to sign this before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

If you have recently signed the CLA, please wait at least one business day
before our records are updated.

You can check yourself to see if the CLA has been received.

Thanks again for your contribution, we look forward to reviewing it!

@tapaswenipathak
Copy link
Contributor Author

@tapaswenipathak tapaswenipathak commented Sep 2, 2019

Signed the CLA.

@JulienPalard
Copy link
Member

@JulienPalard JulienPalard commented Sep 3, 2019

Hi thanks for contributing!

I don't get the tweak about the version banner, can you explain? Anyway we moved the banner on the cpython repostory, here: https://github.com/python/cpython/blob/master/Doc/tools/templates/layout.html#L4-L10
I would prefer not mixing this feature in two repositories. Also the python-docs-theme is aimed to be used by multiple projects around Python, not Python only, so I don't think speaking of the Python project is a good idea here.

@tapaswenipathak
Copy link
Contributor Author

@tapaswenipathak tapaswenipathak commented Sep 3, 2019

@JulienPalard
Copy link
Member

@JulienPalard JulienPalard commented Sep 3, 2019

Mind you closing that issue out

You mean closing this PR? I think you can do if you think it should.

my comment adds a little line for behavior change, the base that implants the things for your outdated docs behavioral change is https://github.com/python/cpython/blob/e1786b54162e2bfb01ca5aafa19d596c4af5a803/Doc/tools/extensions/suspicious.py#L99-L100 and/or https://github.com/python/cpython/blob/e226e83d36dfc7220d836fb7a249ce18e70cb4a6/Doc/tools/extensions/pyspecific.py#L449-L450,

Those are functions that should output files that should be rebuild during a sphinx build, if I understand correctly, not functions that should list old deprecated documentation files.

To activate the red banner you see here https://docs.python.org/3.4/ for example, we pass the variable from the outside, as an html_context.outdated given directly to sphinx-build.

I think; that I intentionally made open as a question. That said, did you forget
adding inputs for more tiny fixes?

Sorry I don't get the meaning of your sentence :( what do you mean by "inputs for more tiny fixes"? Anyway tiny fixes are welcome, please try to put a single one per pull request.

@tapaswenipathak
Copy link
Contributor Author

@tapaswenipathak tapaswenipathak commented Sep 3, 2019

@JulienPalard
Copy link
Member

@JulienPalard JulienPalard commented Sep 3, 2019

Issue #24 closed, thanks for noticing I forgot to close it :)

Sadly to review other points (CSS and viewports and so) I'm not skilled enough :-(

@tapaswenipathak
Copy link
Contributor Author

@tapaswenipathak tapaswenipathak commented Sep 3, 2019

Issue #24 closed, thanks for noticing I forgot to close it :)

💥

Sadly to review other points (CSS and viewports and so) I'm not skilled enough :-(

No problem! More maintainers can review the PR in the week.

@tapaswenipathak tapaswenipathak deleted the tapaswenipathak:docs branch Oct 14, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.