mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Merge branch '4.x'
This commit is contained in:
@@ -256,6 +256,9 @@ Here is some sample code to accomplish this:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from os import path
|
||||
from sphinx.util.fileutil import copy_asset_file
|
||||
|
||||
def copy_custom_files(app, exc):
|
||||
if app.builder.format == 'html' and not exc:
|
||||
staticdir = path.join(app.builder.outdir, '_static')
|
||||
|
||||
@@ -325,9 +325,9 @@ sure that "sphinx.ext.napoleon" is enabled in `conf.py`::
|
||||
**If True**::
|
||||
|
||||
def __init__(self):
|
||||
\"\"\"
|
||||
"""
|
||||
This will be included in the docs because it has a docstring
|
||||
\"\"\"
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
# This will NOT be included in the docs
|
||||
@@ -509,7 +509,7 @@ sure that "sphinx.ext.napoleon" is enabled in `conf.py`::
|
||||
.. confval:: napoleon_preprocess_types
|
||||
|
||||
True to convert the type definitions in the docstrings as references.
|
||||
Defaults to *True*.
|
||||
Defaults to *False*.
|
||||
|
||||
.. versionadded:: 3.2.1
|
||||
.. versionchanged:: 3.5
|
||||
|
||||
Reference in New Issue
Block a user