-
-
Notifications
You must be signed in to change notification settings - Fork 99
Remove broken Tidelift logo url #816
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| Removed the invalid Tidelift logo URL from the project description metadata. | ||
|
|
||
| -- by :user:`julianz-`. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,33 +6,29 @@ Welcome to Cheroot documentation! | |
| .. toctree:: | ||
| :maxdepth: 1 | ||
| :glob: | ||
| :hidden: | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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:
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. |
||
|
|
||
| history | ||
|
|
||
| .. toctree:: | ||
| :caption: Contributing | ||
| :hidden: | ||
|
|
||
| contributing/guidelines | ||
|
|
||
| .. toctree:: | ||
| :caption: Maintenance | ||
| :hidden: | ||
|
|
||
| contributing/release_guide | ||
|
|
||
| .. toctree:: | ||
| :caption: Reference | ||
| :hidden: | ||
|
|
||
| devguide | ||
| Private (dev) API autodoc <pkg/modules> | ||
|
|
||
|
|
||
| `Cheroot <https://github.com/cherrypy/cheroot>`_ is the high-performance, | ||
| pure-Python HTTP server used by `CherryPy <https://www.cherrypy.dev>`_. | ||
|
|
||
|
|
||
| Indices and tables | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We may want to keep this. It may be good for navigation (or for web spiders crawling the URLs). Something to discuss separately. |
||
| ================== | ||
|
|
||
| * :ref:`genindex` | ||
| * :ref:`modindex` | ||
| * :ref:`search` | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I'd use the
doc, orpackaging, or even justcontribnote 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:skiplabel 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.