Update docs, setup.py, conf.py
This commit is contained in:
@ -3,7 +3,7 @@ import os.path
|
|||||||
project = 'lightweight-charts-python'
|
project = 'lightweight-charts-python'
|
||||||
copyright = '2023, louisnw'
|
copyright = '2023, louisnw'
|
||||||
author = 'louisnw'
|
author = 'louisnw'
|
||||||
release = '1.0.18'
|
release = '1.0.20'
|
||||||
|
|
||||||
extensions = [
|
extensions = [
|
||||||
"myst_parser",
|
"myst_parser",
|
||||||
|
|||||||
@ -152,6 +152,13 @@ ___
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
```{py:method} marker_list(markers: list) -> List[str]
|
||||||
|
|
||||||
|
Creates multiple markers and returns a list of marker ids.
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
```{py:method} remove_marker(marker_id: str)
|
```{py:method} remove_marker(marker_id: str)
|
||||||
|
|
||||||
Removes the marker with the given id.
|
Removes the marker with the given id.
|
||||||
@ -342,7 +349,7 @@ ___
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
````{py:method} create_subchart(position: FLOAT, width: float, height: float, sync: bool | str, scale_candles_only: bool, toolbox: bool) -> AbstractChart
|
````{py:method} create_subchart(position: FLOAT, width: float, height: float, sync: bool | str, sync_crosshairs_only: bool, scale_candles_only: bool, toolbox: bool) -> AbstractChart
|
||||||
|
|
||||||
Creates and returns a Chart object, placing it adjacent to the previous Chart. This allows for the use of multiple chart panels within the same window.
|
Creates and returns a Chart object, placing it adjacent to the previous Chart. This allows for the use of multiple chart panels within the same window.
|
||||||
|
|
||||||
@ -355,6 +362,9 @@ Creates and returns a Chart object, placing it adjacent to the previous Chart. T
|
|||||||
`sync`
|
`sync`
|
||||||
: If given as `True`, the Subchart's timescale and crosshair will follow that of the declaring Chart. If a `str` is passed, the Chart will follow the panel with the given id. Chart ids can be accessed from the `chart.id` attribute.
|
: If given as `True`, the Subchart's timescale and crosshair will follow that of the declaring Chart. If a `str` is passed, the Chart will follow the panel with the given id. Chart ids can be accessed from the `chart.id` attribute.
|
||||||
|
|
||||||
|
`sync_crosshairs_only`
|
||||||
|
: If given as `True`, only the crosshairs will be synced and movement will remain independant.
|
||||||
|
|
||||||
```{important}
|
```{important}
|
||||||
`width` and `height` should be given as a number between 0 and 1.
|
`width` and `height` should be given as a number between 0 and 1.
|
||||||
```
|
```
|
||||||
|
|||||||
2
setup.py
2
setup.py
@ -5,7 +5,7 @@ with open('README.md', 'r', encoding='utf-8') as f:
|
|||||||
|
|
||||||
setup(
|
setup(
|
||||||
name='lightweight_charts',
|
name='lightweight_charts',
|
||||||
version='1.0.19',
|
version='1.0.20',
|
||||||
packages=find_packages(),
|
packages=find_packages(),
|
||||||
python_requires='>=3.8',
|
python_requires='>=3.8',
|
||||||
install_requires=[
|
install_requires=[
|
||||||
|
|||||||
Reference in New Issue
Block a user