diff options
| author | Mats Wichmann <mats@linux.com> | 2020-05-28 14:49:38 (GMT) |
|---|---|---|
| committer | Mats Wichmann <mats@linux.com> | 2020-05-30 12:48:15 (GMT) |
| commit | be613a49ef4e12b5b71b6ba1238e6762f29878cd (patch) | |
| tree | a3050d5852484468d1e35fd41b6262aa75b718de /doc/sphinx | |
| parent | 7ea666723c18c7fbd13fe282697591a0a2fd26d2 (diff) | |
| download | SCons-be613a49ef4e12b5b71b6ba1238e6762f29878cd.zip SCons-be613a49ef4e12b5b71b6ba1238e6762f29878cd.tar.gz SCons-be613a49ef4e12b5b71b6ba1238e6762f29878cd.tar.bz2 | |
sphinx build: drop special members [ci skip]
Opinion time - when special members are included in the docs,
the output isn't really readable, it's too cluttered. Don't
seem to be able to get the autoclasstoc stuff working, which
was supposed to help with that.
Signed-off-by: Mats Wichmann <mats@linux.com>
Diffstat (limited to 'doc/sphinx')
| -rw-r--r-- | doc/sphinx/conf.py | 4 | ||||
| -rw-r--r-- | doc/sphinx/index.rst | 9 |
2 files changed, 11 insertions, 2 deletions
diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py index 141d089..21a982f 100644 --- a/doc/sphinx/conf.py +++ b/doc/sphinx/conf.py @@ -44,14 +44,14 @@ autosummary_generate = True autodoc_default_options = { "members": True, - "special-members": True, + #"special-members": True, "private-members": True, "inherited-members": True, "undoc-members": True, "exclude-members": '__weakref__', } autodoc_exclude_members = ['*Tests'] -napoleon_include_special_with_doc = True +napoleon_include_special_with_doc = False napoleon_include_private_with_doc = True # Add any paths that contain templates here, relative to this directory. diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst index eec3750..6828154 100644 --- a/doc/sphinx/index.rst +++ b/doc/sphinx/index.rst @@ -6,6 +6,15 @@ SCons Project API Documentation =============================== +This is the internal API Documentation for SCons. +The Documentation is generated using the Sphinx tool. +The target audience is developers working on SCons itself, +so it does not clearly delineate what is "Public API" - +interfaces for use in your SCons configuration scripts +which have a consistency guarantee, and what is internal, +so always keep the SCons manual page around for helping +with such determinations. + .. toctree:: :maxdepth: 2 :caption: Contents: |