python - How to generate index.rst alone or generate everything excluding conf.py by sphinx-apidocs? -
I understand that creating RRT for all the following modules, except index.rst
< Pre> Sphinx-apidoc -f -o lot_good_dex / very-good
and everything below, which contains index.rst, conf.py, Makefile, etc.
sphinx-pdok-f-f-o-lot-good_dex / very good
The problem is that the Sphinx-APIID is not confp correct Produces, so always include me to confp man Must correct modify the sys.paths if I modify my Python code in the "Very Good" folder, then I should run the sphinx-opidoc command without "-F", so conf.py was preserved. is. However, if I add new module directly to a very disturbance, index.rst is not updated without "-F" option, which means that my new module will not be in the doctor. I believe that either a person only generates the index.rst file, or using the "- F" option without overwriting the confaj. Is there any way to do this?
This is just some experience.
My approach is to use a custom config.py
and always specifies that I sphinx-build
-F
With options This way my config.py "is not overwritten, even if something new (and worthless)
config.py
has been created.
To specify a custom config.py
you should use the -c
option as described in the document:
< Code> -c path in the source source directory .py, but use the given configuration directory. Note that other files and paths provided by the configuration values are expected to be relative to the configuration directory, so they must also be present at this location. The new
command in version 0.3 will look like this:
Sphinx-Build-B HTML-C% Sphinx Config Dyier %% Source Code %% Build Dior %
Hope it helps.
Comments
Post a Comment