Quick start sphinx
$ sphinx-quickstart
Create folder for rst files
$ mkdir rst
Remove old rst files and generate rst, and make html files
$ rm -rf rst/ && sphinx-apidoc -f -o rst/ ../scripts_root/ && make htm
If you want to include all rst files in index.rst. cd to rst/ folder and run:
Gotcha:
$ sphinx-quickstart
Create folder for rst files
$ mkdir rst
Remove old rst files and generate rst, and make html files
$ rm -rf rst/ && sphinx-apidoc -f -o rst/ ../scripts_root/ && make htm
If you want to include all rst files in index.rst. cd to rst/ folder and run:
for f in *.rst;
do
printf 'rst/%s\n' "${f%.rst}"
done
Gotcha:
If there is "-" in your folder structure, sphinx will trow error:
WARNING: invalid signature for automodule
