Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 10 additions & 19 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,30 +58,21 @@ Actions CI/CD workflows.
For Enterprise
==============

.. list-table::
:widths: 10 100
Professional support for Cheroot is available as part of the
`Tidelift Subscription`_. The CherryPy maintainers and the
maintainers of thousands of other packages are working with
Tidelift to deliver one enterprise subscription that covers all
of the open source you use.

* - |tideliftlogo|
- Professional support for Cheroot is available as part of the
`Tidelift Subscription`_. The CherryPy maintainers and the
maintainers of thousands of other packages are working with
Tidelift to deliver one enterprise subscription that covers all
of the open source you use.
Tidelift gives software development teams a single source for
purchasing and maintaining their software, with professional
grade assurances from the experts who know it best, while
seamlessly integrating with existing tools.

Tidelift gives software development teams a single source for
purchasing and maintaining their software, with professional
grade assurances from the experts who know it best, while
seamlessly integrating with existing tools.

`Learn more <Tidelift Subscription_>`_.
`Learn more <Tidelift Subscription_>`_.

.. _Tidelift Subscription: https://tidelift.com/subscription/pkg/pypi-cheroot?utm_source=pypi-cheroot&utm_medium=referral&utm_campaign=readme

.. |tideliftlogo| image:: https://cdn2.hubspot.net/hubfs/4008838/website/logos/logos_for_download/Tidelift_primary-shorthand-logo.png
:target: https://tidelift.com/subscription/pkg/pypi-cheroot?utm_source=pypi-cheroot&utm_medium=readme
:width: 75
:alt: Tidelift

Contribute Cheroot
==================
**Want to add something to upstream?** Feel free to submit a PR or file an issue
Expand Down
3 changes: 3 additions & 0 deletions docs/changelog-fragments.d/816.doc.rst
Copy link
Member

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, 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.

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-`.
12 changes: 4 additions & 8 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,33 +6,29 @@ Welcome to Cheroot documentation!
.. toctree::
:maxdepth: 1
:glob:
:hidden:
Copy link
Member

Choose a reason for hiding this comment

The 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
Copy link
Member

Choose a reason for hiding this comment

The 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`
Loading