Sphinx: documenting entrypoints (console scripts) of a python library

I am developing a small python 3.10 library. I have integrated Sphinx 5.0 to document the project functions, classes, modules etc. This runs on a ubuntu container. The documentation is working. The point that confuses me is how to properly document the use of the library multiple entrypoints?

More specifically, in my setup.cfg, I wrote the following:

[options.entry_points]
console_scripts =
    crumbs-fit-sdm = crumbs.sdm.fit:main

So that after installation the user can type in the terminal eg crumbs-fit-sdm input -v without having to locate the .py file.

How to have Sphinx properly (and automatically) document this feature along with the available options?

edited Jun 4, 2022 at 5:04

mzjn

51.5k16 gold badges139 silver badges265 bronze badges

asked Jun 4, 2022 at 2:13

WaterFox

1,2361 gold badge15 silver badges31 bronze badges

1

You can document console scripts, but not by using autodoc (if that is what you mean). Sphinx with autodoc documents modules by importing them. See stackoverflow.com/q/21003048/407651, stackoverflow.com/q/49179200/407651, stackoverflow.com/q/10886841/407651

mzjn
– mzjn

2022-06-04 05:39:03 +00:00
Commented Jun 4, 2022 at 5:39
That answers my question, thank you :)

WaterFox
– WaterFox

2022-06-08 23:38:43 +00:00
Commented Jun 8, 2022 at 23:38

Add a comment |

0

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.

Collectives™ on Stack Overflow

Sphinx: documenting entrypoints (console scripts) of a python library [duplicate]

0

Linked

Hot Network Questions