By default, Sphinx uses the values specified in the conf.py
file to configure the documentation. However, if you want to modify these settings and use your own configurations, you can pass them directly to the autodoc
extension.
To do this, you need to create a separate configuration file (e.g., autodoc_conf.py
) where you can override the default configurations. In this file, you can import the values from conf.py
and modify or add new ones. For example:
# autodoc_conf.py
# Import the values from conf.py
from conf import *
# Override the default configurations
autodoc_member_order = 'bysource'
autodoc_default_options = {
'members': True,
'undoc-members': True,
'private-members': True,
}
Then, when you run Sphinx, you can specify the autodoc_conf.py
file as the configuration file instead of conf.py
. For example:
sphinx-build -b html -c /path/to/autodoc_conf.py source_dir build_dir
This will use the configurations specified in autodoc_conf.py
instead of conf.py
. Note that any settings not overridden in autodoc_conf.py
will still use the values defined in conf.py
.
Please start posting anonymously - your entry will be published after you log in or create a new account. This space is reserved only for answers. If you would like to engage in a discussion, please instead post a comment under the question or an answer that you would like to discuss
Asked: 2023-07-05 19:12:46 +0000
Seen: 9 times
Last updated: Jul 05 '23
How to perform batch geocoding when longitude and latitude values are missing?
How can a new object with a specific type be created in Angular 2 using the domain model?
What is the method to eliminate NA from facet_wrap in ggplot2?
How can a text/varchar column be shortened when duplicate values are not permitted?
How are `all: unset` and `all: revert` dissimilar from each other?
How can I set values on a Map using more than one parameter from a nativeQuery?
What is the problem encountered when attempting to filter the column values of a data.frame?
How can an array be filtered using the values in another array?