1. cherrypy
  2. CherryPy
  3. Pull requests

Pull requests

#72 Merged
Repository
CherryPy-Documentation
Branch
default
Repository
CherryPy
Branch
default

Documentation reworking

Author
  1. Sylvain Hellegouarch
Reviewers
Description

Our documentation, although rich, is often mentioned as a weak point of the project. This PR tries to make it easier for newbies to start with CherryPy whilst keeping the more in-depth discussion we can found on the existing doc. Hopefully this will be seen a good step forward.

The doc is generated on RTD: cherrypydocrework.readthedocs.org

  • Issues #1312: What is the default response timeout? resolved

Comments (6)

  1. Joel Rivera

    It looks more concise, straight forward and covers a LOT of the usual pitfalls =). Just give it a full read. Did you consider that the streaming docs was too much details? I didn't find any of that on the docs. I have also found three typos but I guess those are not that relevant. Thank you Sylvain. It looks awesome.

  2. Sylvain Hellegouarch author

    Thanks for reading it. Much appreciated.

    The typos will be swiftly fixed once merged. As for the streaming feature, I just forgot it. There are many other features not covered (many tools are left out for now).