Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Avoid printing dot when copyright holder already ends with dot #666

Merged
merged 2 commits into from
Sep 16, 2018

Conversation

FrostyX
Copy link
Contributor

@FrostyX FrostyX commented Aug 14, 2018

When you set copyright = "My Company, Inc." in conf.py for your documentation and generate html from it, the copyright is rendered like this:

© Copyright 2018, My Company, Inc..

Which is bad, we ideally want to have only one dot at the end.

It can't be workarounded by setting copyright = "My Company, Inc", because then man pages get rendered wrong, e.g.

AUTHOR
       My Company, Inc.

COPYRIGHT
       2018, My Company, Inc

Therefore I am proposing this pull request. It is quite hard to fix it properly because it needs to be done per-theme and therefore it can bring some inconsistencies. If there is a better way to fix it, please let me know.

@Blendify
Copy link
Member

I would rather we remove the second added period and leave it up to the author how the copyright is punctuated.

@FrostyX
Copy link
Contributor Author

FrostyX commented Aug 15, 2018

@Blendify thank you for the reply. Do you like this solution better?
(Let me know before merging, I will rebase and squash the commits)

Copy link
Member

@Blendify Blendify left a comment

Choose a reason for hiding this comment

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

I like this plan better. +1

@FrostyX
Copy link
Contributor Author

FrostyX commented Aug 16, 2018

Alright @Blendify, I've rebased the PR.

@Blendify
Copy link
Member

Ok, looking for one more quick approval.

@jessetan
Copy link
Contributor

I'd like it even better if the user could customize the entire copyright message (including copyright sign), but that is more the responsibility of Sphinx.

LGTM

@Blendify Blendify merged commit 6bed095 into readthedocs:master Sep 16, 2018
emodric added a commit to netgen-layouts/layouts-docs that referenced this pull request Oct 4, 2018
emodric added a commit to netgen-layouts/content-browser-docs that referenced this pull request Oct 4, 2018
emodric added a commit to netgen/NetgenDocs that referenced this pull request Oct 4, 2018
Odyseus added a commit to Odyseus/sphinx_rtd_theme_mod that referenced this pull request Nov 29, 2018
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants