I'm working on a Python library that only has a single .py module and I'm trying to generate documentation for it from the docstrings. I have Sphinx set up and ran through the spinx-quickstart script, but when I try to run (while in the docs directory)
sphinx-apidoc ../cffiwrap.py -o .
But it just says:
../cffiwrap.py is not a directory.
Is there some other Sphinx script to autodoc a single file? I thought about just running it against ..
but then I figured it would run in to my tests directory and try to generate docs from my unit tests...
The manual says:
So try:
where
test_dir
is where your tests live.