-
Notifications
You must be signed in to change notification settings - Fork 34
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
It would be awesome if you could add a spot for apidoc calls #16
Comments
Hello, sorry for replying so late. Do you have an example of this? If we generate apidoc for a python object, we do not need to call sphinx-apidoc by hand. |
I've encountered the same issue and have implemented some modifications in my fork available at https://github.com/hesic73/pages, where I also introduced a parameter import os
import sys
sys.path.insert(0, os.path.abspath('..')) |
Hi @hesic73, what the value of B.T.W. Are you willing to make a pull request? |
According to https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html, MODULE_PATH is the path to a Python package to document. For example in my repository, For now it's hard-coded. But this should be an optional parameter. Maybe I will change the code and make a pr. |
Yes, it would be better to make the parameter optional. Besides, I think |
An option before the push that would allow us to enter a popular apidoc call for example "sphinx-apidoc -f -o . .." With this we could completely automate sphinx docs on push.
The text was updated successfully, but these errors were encountered: