FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Added copyright link for the devguide by jablonskidev · Pull Request #665 · python/devguide · GitHub

Repository navigation

Added copyright link for the devguide - #665

Closed
jablonskidev wants to merge 1 commit into
python:mainfrom
jablonskidev:master
Closed

jablonskidev wants to merge 1 commit into
python:mainfrom
jablonskidev:master

Conversation

Copy link
Copy Markdown
Contributor

In order to resolve issues #652 and #653 in the devguide (which are duplicates of each other), we added a theme variable to python_docs_theme/layout.html in PR #67. This will allow all users of the python-docs-theme library to have more functionality and backwards compatibility. In addition, if users don't define a link for copyright information, then they won't have a broken link that leads to nowhere in their page footer.

In order to have the correct copyright link for the devguide specifically, we just needed to specify it in the html_theme_options dictionary in the devguide's conf.py, which I did in this commit.

In order to resolve issues python#652 and python#653 in the devguide (which are duplicates of each other), we added a theme variable to `python_docs_theme/layout.html` in PR python#67. This will allow all users of the python-docs-theme library to have more functionality and backwards compatibility. In addition, if users don't define a link for copyright information, then they won't have a broken link that leads to nowhere in their page footer.

In order to have the correct copyright link for the devguide specifically, we just needed to specify it in the `html_theme_options` dictionary in the devguide's `conf.py`, which I did in this commit.

Copy link
Copy Markdown
Contributor Author

@CAM-Gerlach The build failed because the changes to python_docs_theme/layout.html that we discussed in PR #67 for python-docs-theme have not yet been merged. Here's the error message:

From what I understand, I just need to wait for you to merge the changes to python_docs_theme/layout.html, and then we can test that the changes I'm proposing in this PR work.

Copy link
Copy Markdown
Member

Yup, exactly, except I'm not an org member, just a drive-by contributor, so I can't merge anything haha! That's up to @Mariatta , I assume, and depends on how you have your infra set up to pull in the theme (which I'm not really familiar with). Thanks!

Copy link
Copy Markdown
Member

Hi @jablonskidev

Could you check with my python/python-docs-theme#67 (comment) ?

Thank you

Copy link
Copy Markdown
Member

Hey, looks like the theme changes were merged @jablonskidev . Any chance this could get a rebuild?

hugovk commented Jan 27, 2022

Copy link
Copy Markdown
Member

Let's close this because the devguide is now using the Furo theme instead (#679) which doesn't support the copyright_url option:

But thanks anyway for the PR!

hugovk closed this Jan 27, 2022

Copy link
Copy Markdown
Member

Oh well; so much for all that, heh.

hugovk commented Jan 27, 2022

Copy link
Copy Markdown
Member

On the bright side, python_docs_theme was improved for others :)

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
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.

5 participants


Back | FazBrowse Home | New Git URL