python-conflux-sdk/docs/en/_config.yml at 542af3bf7b855d9f3bf466c0b544edb80d0a1d13 · Conflux-Chain/python-conflux-sdk · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# Book settings
# Learn more at https://jupyterbook.org/customize/config.html
# Comprehensive example: https://github.com/executablebooks/jupyter-book/blob/master/docs/_config.yml

title: python-conflux-sdk
author: Conflux
logo: ../logo.png

# Force re-execution of notebooks on each build.
# See https://jupyterbook.org/content/execute.html
execute:
  execute_notebooks: 'off'

# Information about where the book exists on the web
repository:
  url: https://github.com/conflux-chain/python-conflux-sdk  # Online location of your book
  path_to_book: docs/en  # Optional path to your book, relative to the repository root
  branch: v1  # Which branch of the repository should be used when creating links (optional)

# Add GitHub buttons to your book
# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
html:
  use_issues_button: true
  use_repository_button: true

launch_buttons:
  binderhub_url: "https://mybinder.org"
  colab_url: "https://colab.research.google.com"
  thebe: true

sphinx:
  extra_extensions:
  - 'sphinx.ext.autodoc'
  - 'sphinx.ext.viewcode'
  - 'sphinx.ext.napoleon'
  - 'sphinx.ext.doctest'
  - 'IPython.sphinxext.ipython_console_highlighting'
  - 'sphinx_autodoc_typehints'
  # - 'sphinx.ext.intersphinx'
  # - 'sphinx.ext.autosummary'
  config:
    # autosummary_generate: True
    autoclass_content: "both"
    # autodoc_typehints: 'description'
    copyright: "2025"
    # autodoc_type_aliases: {
    #   'TxParam': 'cfx_utils.types.TxParam'
    # }
    typehints_fully_qualified: true
    # napoleon_use_param: true
    # always_document_param_types: true
    # napoleon_preprocess_types: true
    typehints_use_signature: true
    typehints_use_signature_return: true
    always_use_bars_union: true