sphinx-apidoc: index.rst not generated

263 views
Skip to first unread message

c.b...@posteo.jp

unread,
Mar 2, 2022, 3:26:16 AM3/2/22
to sphinx-users
I am quite new to sphinx I try to figuring out autodocumenting my
Python code with it. I have setup a test-project [1] to play around
with some settings.

I found a lot of tutorials/blogs in the web [2][3]. In all of them the sphinx-apidoc call generates an index.rst. But in my project [1] it does not happen. And the "make html" run then throw an error about the missing index.rst.

It is unclear for me what index.rst is for. Why is it generate in some situations and in some not?

I tried this two variants for the sphinx-apidoc call.

sphinx-apidoc -f -o source ../src/mypackage
sphinx-apidoc -f -o source ../src

The complete package can be found in [1].

[1] -- <https://codeberg.org/buhtz/sphinx_versuch>
[2] -- <https://betterprogramming.pub/auto-documenting-a-python-project-using-sphinx-8878f9ddc6e9>
[3] -- <https://samnicholls.net/2016/06/15/how-to-sphinx-readthedocs/>
Reply all
Reply to author
Forward
0 new messages