]> xn--ix-yja.es Git - alex.git/commitdiff
Try to be more clear about the purpose of Sphinx
authorAlex Corcoles <alex@pdp7.net>
Fri, 1 Mar 2024 19:36:46 +0000 (20:36 +0100)
committerAlex Corcoles <alex@corcoles.net>
Fri, 1 Mar 2024 20:28:01 +0000 (20:28 +0000)
programming/python/project_setup.md

index 2d66db827fad2131b9b4e75661909f8338c34be3..095ced3e2dc3cd8de0ebe4b9046f4ce93814485c 100644 (file)
@@ -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