Remove broken Tidelift logo url

[julianz-]

❓ What kind of change does this PR introduce?

• 🐞 bug fix
• 🐣 feature
• 📋 docs update
• 📋 tests/coverage improvement
• 📋 refactoring
• 💥 other

📋 What is the related issue number (starting with #)
#812

Resolves #

❓ What is the current behavior? (You can also link to an open issue here)
#812

❓ What is the new behavior (if this is a feature change)?
#812

📋 Other information:

📋 Contribution checklist:

(If you're a first-timer, check out
this guide on making great pull requests)

• I wrote descriptive pull request text above
• I think the code is well written
• I wrote good commit messages
• I have squashed related commits together after
  the changes have been approved
• Unit tests for the changes exist
• Integration tests for the changes exist (if applicable)
• I used the same coding conventions as the rest of the project
• The new code doesn't generate linter offenses
• Documentation reflects the changes
• The PR relates to only one subject with a clear title
  and description in grammatically correct, complete sentences

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.19%. Comparing base (4bb134f) to head (f4487aa).
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #816      +/-   ##
==========================================
- Coverage   78.21%   78.19%   -0.03%     
==========================================
  Files          41       41              
  Lines        4788     4788              
  Branches      547      547              
==========================================
- Hits         3745     3744       -1     
  Misses        905      905              
- Partials      138      139       +1     

[webknjaz]

• [ X] 🐞 bug fix

@julianz- ^ when you have a whitespace in there, it doesn't render as a checkbox. Try fixing it in the PR description?

[webknjaz]

I don't think we should have a duplicate badge in this place — it's already present at the top of the document.

How about integrating a Sphinx extension following what's done in pypa/setuptools@918a415 instead? We could drop this section from the readme that's rendered on GH but keep it integrated in the Sphinx docs (the directive from jaraco's extension would go into docs/index.rst).

[julianz-]

There are a couple of issues in doing this:

1. I believe removing the Enterprise section from README.rst would mean it will no longer appear on the PyPI page. Is that acceptable?
2. Moving the Enterprise section to docs/index.rst would change the order in which things appear here. I guess it would have to go under the license. Again is that acceptable?

[webknjaz]

Yeah, that should be fine — though, we could either include a text paragraph of have an additional document listed @

cheroot/pyproject.toml

Line 72 in 4bb134f

file = "README.rst"

— setuptools has a feature to merge multiple documents into the metadata (https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html#dynamic-metadata). Actually, that ToC at the end of the index page on RTD is rather weird. Ideally, it shouldn't duplicate the left sidebar — perhaps, we could remove it. Not sure what causes it appearing in there.

Anyway, I'm good with either a text paragraph in readme or none at all. No logo in both cases, only in the Sphinx docs. Another alternative could be integrating cogapp (I think examples of it would be found in the attrs and coveragepy repos). But for now, I just want Sphinx to stop failing and thats my primary motivation.

[julianz-]

I removed the logo from Enterprise section of README.rst. Adding the logo to docs/index.rst instead is not really viable unless we also move the Enterprise section out of the README. I also removed the duplicated ToC in the RTD and some additional stuff called Indices and tables. Is that actually needed?

I also added:

"Source" = "https://github.com/cherrypy/cheroot" 

to the [project.urls] in pyproject.toml as its absence was causing another linter error. Maybe there's been a change of version that brought this issue to light? Should this go in a separate PR?

[webknjaz]

Yes, I'd rather go with atomic PRs. We can force-merge if the CI's temporarily unhappy. Worst case, we could have PRs with multiple atomic commits and multiple change notes but those are more difficult to track/reason about and more small details often end up blocking parts of the patch that could be merged sooner.

[webknjaz]

If you want to reference a file in RST, you can use roles like

Suggested change

	Removed non-functioning Tidelift Logo url from README.rst.
	Removed the non-functioning Tidelift logo URL from :file:`README.rst`.

Though, since the change log is supposed to be more high-level, instead of files we could be talking about the effect the users would observe.

Suggested change

	Removed non-functioning Tidelift Logo url from README.rst.
	Removed the malfunctioning Tidelift logo URL from the project description metadata.

[webknjaz]

Resolves #

Keywords like this can be used to auto-close issues/PRs once this PR is merged. But only if you actually fill out the issue number to close after #, not on a previous line: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests

[webknjaz]

We may want to keep this. It may be good for navigation (or for web spiders crawling the URLs). Something to discuss separately.

[webknjaz]

Oh, I'd forgotten about this solution. Of course, its should go into a separate PR. If you're up it, feel free to send the same fix to my octomachinery project.

---

Tip

Additionally, I've here's a few Sphinx docs examples to bookmark:

• https://github.com/ansible/awx-plugins/blob/devel/docs/index.md?plain=1
• https://github.com/jazzband/pip-tools/blob/main/docs/index.md?plain=1
• https://github.com/pytest-dev/pytest/blob/main/doc/en/index.rst?plain=1

We can later borrow some nice ideas from these — like an additional MyST-Parser integration and partial inclusion of README/CONTRIBUTING/LICENSE files into Sphinx docs, plus the ability to mix RST+MD in the same Sphinx project.

In general, I'm usually trying to sync bits of the project structure/layout across the repos I'm involved in. So any change that can be scaled to other projects is usually considered through the prism of how easy it is to reproduce across the board with minimum effort.

[webknjaz]

I think I'd use the doc, or packaging, or even just contrib note category. Though, a case could be made for not having a change note for this bit at all.

If you believe that a patch truly does not need to show up in the change log, feel free to apply the bot:chronographer:skip label to PRs and the bot will stop complaining about a news fragment missing. Be ready to justify this, of course since sometimes I may have a different opinion and we'll need to agree on what to do.

[webknjaz]

@julianz- plz feel free to apply any labels you see fit on your own too.

[webknjaz]

Looks like you need to configure your text editor not to trim trailing LF @ EOF..