diff options
| author | Alex Corcoles <alex@pdp7.net> | 2024-03-01 20:36:46 +0100 |
|---|---|---|
| committer | Alex Corcoles <alex@corcoles.net> | 2024-03-01 20:28:01 +0000 |
| commit | e51a8145609899daa9f9f30e24e6de50dbaa37d0 (patch) | |
| tree | e46fbe961843974cac5dcc3eabef236abc9c84f5 /programming | |
| parent | c65eecd5d79dcb340d7154309b8dcf60f388f16f (diff) | |
Try to be more clear about the purpose of Sphinx
Diffstat (limited to 'programming')
| -rw-r--r-- | programming/python/project_setup.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/programming/python/project_setup.md b/programming/python/project_setup.md index 2d66db82..095ced3e 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 |