diff options
author | Mats Wichmann <mats@linux.com> | 2020-06-10 17:09:09 (GMT) |
---|---|---|
committer | Mats Wichmann <mats@linux.com> | 2020-06-10 17:12:42 (GMT) |
commit | 2f5841806011b1ca123e58ddaa55e4319b5468da (patch) | |
tree | 44c9910e3aa95d45766d6b67a7a3ca5987c3036e /doc/sphinx | |
parent | 07ba4716ef08158da819ec98b4533d06c84c12dc (diff) | |
download | SCons-2f5841806011b1ca123e58ddaa55e4319b5468da.zip SCons-2f5841806011b1ca123e58ddaa55e4319b5468da.tar.gz SCons-2f5841806011b1ca123e58ddaa55e4319b5468da.tar.bz2 |
Documentation updates in perparation for 4.0 [ci skip]
* Switch API docs to readthedocs theme
* Add links in manpage SEE ALSO to external websites. These are not just
live, but also listed out (Linux manpages won't have the hyperlinks)
* Links use docbook5 xlink:href instead of deprecated (claimed to be
removed, but apparently not) ulink syntax
* Comment out manpage Examples section, and leave a pointer to
scons-cookbook.readthedocs.io instead
* Regenerate everything, mainly to pick up compilation_db stuff.
Signed-off-by: Mats Wichmann <mats@linux.com>
Diffstat (limited to 'doc/sphinx')
-rw-r--r-- | doc/sphinx/conf.py | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py index 21a982f..9469e06 100644 --- a/doc/sphinx/conf.py +++ b/doc/sphinx/conf.py @@ -31,13 +31,14 @@ needs_sphinx = '1.3' # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'autoclasstoc', + #'autoclasstoc', # TODO: figure out how to make this useful 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', #'sphinx.ext.githubpages' 'sphinx.ext.napoleon', 'sphinx.ext.todo', 'sphinx.ext.viewcode', + 'sphinx_rtd_theme', ] autosummary_generate = True @@ -74,10 +75,11 @@ author = 'SCons Project Team' # |version| and |release|, also used in various other places throughout the # built documents. # +# TODO: fill these in externally # The short X.Y version. version = '4.0' # The full version, including alpha/beta/rc tags. -release = '4.0.0a1' +release = '4.0.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -103,14 +105,16 @@ todo_include_todos = False # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -#html_theme = 'alabaster' -html_theme = 'classic' +html_theme = "sphinx_rtd_theme" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. # -# html_theme_options = {} +html_theme_options = { + "collapse_navigation": False, + "navigation_depth": 3, +} # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, |