build: Updating the sphinx configuration (#9833)

Co-authored-by: John Bodley <john.bodley@airbnb.com>
This commit is contained in:
John Bodley
2020-05-18 21:27:25 -07:00
committed by GitHub
parent d96bb874f2
commit c117e222c0
3 changed files with 10 additions and 8 deletions

View File

@@ -31,6 +31,9 @@ import shlex
import sys
import sphinx_rtd_theme
from pandas._typing import ArrayLike # Somehow required for type-checking.
from superset import security_manager # Somehow required for type-checking.
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
@@ -304,3 +307,7 @@ texinfo_documents = [
# If true, do not generate a @detailmenu in the "Top" node's menu.
# texinfo_no_detailmenu = False
# -- Options for sphinx-autodoc-typehints -------------------------------------
set_type_checking_flag = True

View File

@@ -15,5 +15,5 @@
# limitations under the License.
#
sphinx==3.0.1
sphinx_autodoc_typehints==1.10.3
sphinx-autodoc-typehints==1.10.3
sphinx-rtd-theme==0.4.3

View File

@@ -79,16 +79,11 @@ Superset's Jinja context:
`Jinja's builtin filters <http://jinja.pocoo.org/docs/dev/templates/>`_ can be also be applied where needed.
.. autofunction:: superset.jinja_context.ExtraCache.current_user_id
.. autofunction:: superset.jinja_context.ExtraCache.current_username
.. autofunction:: superset.jinja_context.ExtraCache.url_param
.. autoclass:: superset.jinja_context.ExtraCache
:members:
.. autofunction:: superset.jinja_context.filter_values
.. autofunction:: superset.jinja_context.ExtraCache.cache_key_wrapper
.. autoclass:: superset.jinja_context.PrestoTemplateProcessor
:members: