From: Alex Corcoles Date: Fri, 1 Mar 2024 19:36:46 +0000 (+0100) Subject: Try to be more clear about the purpose of Sphinx X-Git-Tag: 20241020-emacs~265 X-Git-Url: https://xn--ix-yja.es/gitweb/?a=commitdiff_plain;h=e51a8145609899daa9f9f30e24e6de50dbaa37d0;p=alex.git Try to be more clear about the purpose of Sphinx --- diff --git a/programming/python/project_setup.md b/programming/python/project_setup.md index 2d66db8..095ced3 100644 --- a/programming/python/project_setup.md +++ b/programming/python/project_setup.md @@ -106,7 +106,7 @@ If the `README` becomes unwieldly, separate usage instructions to `USAGE` and/or Provide docstrings detailing the external interface of Python modules. Provide internal comments in modules detailing implementation. -Consider the use of Sphinx to render documentation and publish it to the web if developing a library/framework. +If you are developing a library/framework, consider using Sphinx. Sphinx can create a documentation website for a Python project, taking advantage of docstrings. # Distribution