Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Updated copyright link to license in repo#67

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
matrixise merged 5 commits intopython:masterfromjablonskidev:patch-1
May 25, 2021

Conversation

jablonskidev
Copy link
Contributor

This should fix issues #652 and #653 in the devguide. (The issues are duplicates of each other, so this PR is still addressing only one issue at a time.)

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
@jablonskidev
Copy link
ContributorAuthor

@CAM-Gerlach Thanks again, that was super helpful, and I learned more about Sphinx along the way. I committed your second suggestion and will also submit a PR to add the license URL to the dictionaryhtml_theme_options inside the devguide'sconf.py.

@CAM-Gerlach
Copy link
Member

You're welcome, I'm glad! I'm no expert at Sphinx theming either; I know just enough to be dangerous 😆 Looks like its up to@Mariatta for the final review?

@matrixise
Copy link
Member

Could you explain how to use it? because with my workflow, it doesn't work.

git clone https://github.com/python/devguidecd devguidemake venv./venv/bin/pip install -U pip./venv/bin/pip uninstall python-docs-theme./venv/bin/pip install git+https://github.com/jablonskidev/python-docs-theme.git@patch-1

patch with this diff

diff --git a/conf.py b/conf.pyindex 4071095..f20b61f 100644--- a/conf.py+++ b/conf.py@@ -95,6 +95,7 @@ pygments_style = 'sphinx' # Use the upstream python-docs-theme html_theme = 'python_docs_theme' html_theme_options = {+    'copyright_url': 'https://www.demo.org',     'collapsiblesidebar': True,     'issues_url': 'https://github.com/python/devguide/issues/new', }
> make html./venv/bin/sphinx-build -b html -d _build/doctrees   . _build/htmlRunning Sphinx v3.5.4making output directory... doneloading intersphinx inventory from https://docs.python.org/3/objects.inv...building [mo]: targets for 0 po files that are out of datebuilding [html]: targets for 35 source files that are out of dateupdating environment: [new config] 35 added, 0 changed, 0 removedreading sources... [100%] triaginglooking for now-outdated files... none foundpickling environment... donechecking consistency... donepreparing documents... WARNING: unsupported theme option 'copyright_url' givendonewriting output... [100%] triaginggenerating indices... genindex donewriting additional pages... search donecopying images... [100%] images/python-cyclic-gc-5-new-page.pngcopying static files... donecopying extra files... donedumping search index in English (code: en)... donedumping object inventory... donebuild succeeded, 1 warning.The HTML pages are in _build/html.Build finished. The HTML pages are in _build/html.

As you can see, I have gotWARNING: unsupported theme option 'copyright_url' given

Any idea?

Thank you

@CAM-Gerlach
Copy link
Member

Thanks@matrixise . This PR neglected to add

copyright_url =

intheme.conf as mentioned in my review comment above, and it seems I didn't notice the omission earlier, sorry. That's why you're seeing the warning. However, it may still have worked, I'm not certain—I presume you actually checked the build output and the link was not correct?

@matrixise
Copy link
Member

That's why you're seeing the warning. However, it may still have worked, I'm not certain—I presume you actually checked the build output and the link was not correct?

In fact, without this parameter, the build of the devguide or another project using this PR would generate a Warning with the undefinedcopyright_url option

In this case, thecopyright_url must be defined into thetheme.conf file.

@jablonskidev Could you update your PR with thecopyright_url option?

Thank you

CAM-Gerlach reacted with thumbs up emoji

@matrixisematrixise self-assigned thisMay 6, 2021
@jablonskidev
Copy link
ContributorAuthor

@matrixise@CAM-Gerlach Thanks for your feedback! I addedcopyright_url = totheme.conf. If there's anything else I can do to improve this and help move it forward, then please let me know.

@matrixise
Copy link
Member

Thanks@jablonskidev I am going to check in few minutes.

@matrixise
Copy link
Member

@Mariatta What do you think about this PR, for me, it's fine, and we can merge it.

@matrixise
Copy link
Member

@JulienPalard Just to be sure. For you, is there an issue with this PR and the "copyright" link in the existing documentations? Thanks

Copy link
Member

@matrixisematrixise left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Thank you so much for your contribution.

@matrixisematrixise merged commit6ed468a intopython:masterMay 25, 2021
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@CAM-GerlachCAM-GerlachCAM-Gerlach left review comments

@matrixisematrixisematrixise approved these changes

@JulienPalardJulienPalardJulienPalard approved these changes

@MariattaMariattaAwaiting requested review from Mariatta

Assignees

@matrixisematrixise

Labels
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

6 participants
@jablonskidev@CAM-Gerlach@matrixise@JulienPalard@Mariatta@the-knights-who-say-ni

[8]ページ先頭

©2009-2025 Movatter.jp