Skip to content

Commit 5905da8

Browse files
authored
Fix docs to use markdown link instead of html
1 parent b980669 commit 5905da8

File tree

4 files changed

+21
-19
lines changed

4 files changed

+21
-19
lines changed

docs/concepts/advanced/advanced_orders.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ When the parent order is executed, the two child orders are also placed in the m
4646
If the market moves in favor of the trade, the take-profit order will be filled, closing the position and locking in profits.
4747
If the market moves against the trade, the stop-loss order will be filled, closing the position and limiting losses.
4848

49-
Bracket orders can be created using the [OrderFactory](https://nautilustrader.io/docs/api_reference/common.html#module-nautilus_trader.common.factories) class in the Nautilus Trader API.
49+
Bracket orders can be created using the [OrderFactory](../../api_reference/common.md#class-orderfactorytraderid-trader_id-strategyid-strategy_id-clock-clock-cachefacade-cache-cachefacade--none--none-int-initial_order_id_count0-int-initial_order_list_id_count0) class in the Nautilus Trader API.
5050
This allows for easy and efficient creation of bracket orders, with different order types, parameters and instructions.
5151

5252
:::warning

docs/concepts/advanced/synthetic_instruments.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -110,5 +110,5 @@ Considerable effort has been made to validate inputs, including the derivation f
110110
synthetic instruments. Despite this, caution is advised as invalid or erroneous inputs may lead to
111111
undefined behavior.
112112

113-
Refer to the `SyntheticInstrument` [API reference](https://nautilustrader.io/docs/api_reference/model/instruments.html#nautilus_trader.model.instruments.synthetic.SyntheticInstrument)
113+
Refer to the `SyntheticInstrument` [API reference](../../api_reference/model/instruments.md#class-syntheticinstrumentsymbol-symbol-uint8_t-price_precision-list-components-unicode-formula-uint64_t-ts_event-uint64_t-ts_init)
114114
for a detailed understanding of input requirements and potential exceptions.

docs/concepts/orders.md

+12-10
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ apply to the order type being created, or are only needed to specify more advanc
148148
This leaves the factory with simpler order creation methods to work with, all the
149149
examples will leverage an `OrderFactory` from within a `Strategy` context.
150150

151-
[API Reference](https://nautilustrader.io/docs/api_reference/common.html#module-nautilus_trader.common.factories)
151+
[API Reference](../api_reference/common.md#class-orderfactorytraderid-trader_id-strategyid-strategy_id-clock-clock-cachefacade-cache-cachefacade--none--none-int-initial_order_id_count0-int-initial_order_list_id_count0)
152152

153153
:::info
154154
Any optional parameters will be clearly marked with a comment which includes the default value.
@@ -184,7 +184,8 @@ order: MarketOrder = self.order_factory.market(
184184
tags=["ENTRY"], # <-- optional (default None)
185185
)
186186
```
187-
[API Reference](https://nautilustrader.io/docs/api_reference/model/orders.html#module-nautilus_trader.model.orders.market)
187+
188+
[API Reference](../api_reference/model/orders.md)
188189

189190
### Limit
190191

@@ -215,7 +216,8 @@ order: LimitOrder = self.order_factory.limit(
215216
tags=None, # <-- optional (default None)
216217
)
217218
```
218-
[API Reference](https://nautilustrader.io/docs/api_reference/model/orders.html#module-nautilus_trader.model.orders.limit)
219+
220+
[API Reference](../api_reference/model/orders.md#class-limitordertraderid-trader_id-strategyid-strategy_id-instrumentid-instrument_id-clientorderid-client_order_id-orderside-order_side-quantity-quantity-price-price-uuid4-init_id-uint64_t-ts_init-timeinforce-time_in_forcetimeinforcegtc-uint64_t-expire_time_ns0-bool-post_onlyfalse-bool-reduce_onlyfalse-bool-quote_quantityfalse-quantity-display_qtynone-triggertype-emulation_triggertriggertypeno_trigger-instrumentid-trigger_instrument_idnone-contingencytype-contingency_typecontingencytypeno_contingency-orderlistid-order_list_idnone-list-linked_order_idsnone-clientorderid-parent_order_idnone-execalgorithmid-exec_algorithm_idnone-dict-exec_algorithm_paramsnone-clientorderid-exec_spawn_idnone-list-tagsnone)
219221

220222
### Stop-Market
221223

@@ -247,7 +249,7 @@ order: StopMarketOrder = self.order_factory.stop_market(
247249
tags=None, # <-- optional (default None)
248250
)
249251
```
250-
[API Reference](https://nautilustrader.io/docs/api_reference/model/orders.html#module-nautilus_trader.model.orders.stop_market)
252+
[API Reference](../api_reference/model/orders.md#class-stopmarketordertraderid-trader_id-strategyid-strategy_id-instrumentid-instrument_id-clientorderid-client_order_id-orderside-order_side-quantity-quantity-price-trigger_price-triggertype-trigger_type-uuid4-init_id-uint64_t-ts_init-timeinforce-time_in_forcetimeinforcegtc-uint64_t-expire_time_ns0-bool-reduce_onlyfalse-bool-quote_quantityfalse-triggertype-emulation_triggertriggertypeno_trigger-instrumentid-trigger_instrument_idnone-contingencytype-contingency_typecontingencytypeno_contingency-orderlistid-order_list_idnone-list-linked_order_idsnone-clientorderid-parent_order_idnone-execalgorithmid-exec_algorithm_idnone-dict-exec_algorithm_paramsnone-clientorderid-exec_spawn_idnone-list-tagsnone)
251253

252254
### Stop-Limit
253255

@@ -281,7 +283,7 @@ order: StopLimitOrder = self.order_factory.stop_limit(
281283
tags=None, # <-- optional (default None)
282284
)
283285
```
284-
[API Reference](https://nautilustrader.io/docs/api_reference/model/orders.html#module-nautilus_trader.model.orders.stop_limit)
286+
[API Reference](../api_reference/model/orders.md#class-stoplimitordertraderid-trader_id-strategyid-strategy_id-instrumentid-instrument_id-clientorderid-client_order_id-orderside-order_side-quantity-quantity-price-price-price-trigger_price-triggertype-trigger_type-uuid4-init_id-uint64_t-ts_init-timeinforce-time_in_forcetimeinforcegtc-uint64_t-expire_time_ns0-bool-post_onlyfalse-bool-reduce_onlyfalse-bool-quote_quantityfalse-quantity-display_qtynone-triggertype-emulation_triggertriggertypeno_trigger-instrumentid-trigger_instrument_idnone-contingencytype-contingency_typecontingencytypeno_contingency-orderlistid-order_list_idnone-list-linked_order_idsnone-clientorderid-parent_order_idnone-execalgorithmid-exec_algorithm_idnone-dict-exec_algorithm_paramsnone-clientorderid-exec_spawn_idnone-list-tagsnone)
285287

286288
### Market-To-Limit
287289

@@ -310,7 +312,7 @@ order: MarketToLimitOrder = self.order_factory.market_to_limit(
310312
)
311313
```
312314

313-
[API Reference](https://nautilustrader.io/docs/api_reference/model/orders.html#module-nautilus_trader.model.orders.market_to_limit)
315+
[API Reference](../api_reference/model/orders.md#class-markettolimitordertraderid-trader_id-strategyid-strategy_id-instrumentid-instrument_id-clientorderid-client_order_id-orderside-order_side-quantity-quantity-uuid4-init_id-uint64_t-ts_init-timeinforce-time_in_forcetimeinforcegtc-uint64_t-expire_time_ns0-bool-reduce_onlyfalse-bool-quote_quantityfalse-quantity-display_qtynone-contingencytype-contingency_typecontingencytypeno_contingency-orderlistid-order_list_idnone-list-linked_order_idsnone-clientorderid-parent_order_idnone-execalgorithmid-exec_algorithm_idnone-dict-exec_algorithm_paramsnone-clientorderid-exec_spawn_idnone-list-tagsnone)
314316

315317
### Market-If-Touched
316318

@@ -344,7 +346,7 @@ order: MarketIfTouchedOrder = self.order_factory.market_if_touched(
344346
)
345347
```
346348

347-
[API Reference](https://nautilustrader.io/docs/api_reference/model/orders.html#module-nautilus_trader.model.orders.market_if_touched)
349+
[API Reference](../api_reference/model/orders.md#class-marketiftouchedordertraderid-trader_id-strategyid-strategy_id-instrumentid-instrument_id-clientorderid-client_order_id-orderside-order_side-quantity-quantity-price-trigger_price-triggertype-trigger_type-uuid4-init_id-uint64_t-ts_init-timeinforce-time_in_forcetimeinforcegtc-uint64_t-expire_time_ns0-bool-reduce_onlyfalse-bool-quote_quantityfalse-triggertype-emulation_triggertriggertypeno_trigger-instrumentid-trigger_instrument_idnone-contingencytype-contingency_typecontingencytypeno_contingency-orderlistid-order_list_idnone-list-linked_order_idsnone-clientorderid-parent_order_idnone-execalgorithmid-exec_algorithm_idnone-dict-exec_algorithm_paramsnone-clientorderid-exec_spawn_idnone-list-tagsnone)
348350

349351
### Limit-If-Touched
350352

@@ -380,7 +382,7 @@ order: StopLimitOrder = self.order_factory.limit_if_touched(
380382
)
381383
```
382384

383-
[API Reference](https://nautilustrader.io/docs/api_reference/model/orders.html#module-nautilus_trader.model.orders.limit_if_touched)
385+
[API Reference](../api_reference/model/orders.md#class-limitiftouchedordertraderid-trader_id-strategyid-strategy_id-instrumentid-instrument_id-clientorderid-client_order_id-orderside-order_side-quantity-quantity-price-price-price-trigger_price-triggertype-trigger_type-uuid4-init_id-uint64_t-ts_init-timeinforce-time_in_forcetimeinforcegtc-uint64_t-expire_time_ns0-bool-post_onlyfalse-bool-reduce_onlyfalse-bool-quote_quantityfalse-quantity-display_qtynone-triggertype-emulation_triggertriggertypeno_trigger-instrumentid-trigger_instrument_idnone-contingencytype-contingency_typecontingencytypeno_contingency-orderlistid-order_list_idnone-list-linked_order_idsnone-clientorderid-parent_order_idnone-execalgorithmid-exec_algorithm_idnone-dict-exec_algorithm_paramsnone-clientorderid-exec_spawn_idnone-list-tagsnone)
384386

385387
### Trailing-Stop-Market
386388

@@ -418,7 +420,7 @@ order: TrailingStopMarketOrder = self.order_factory.trailing_stop_market(
418420
)
419421
```
420422

421-
[API Reference](https://nautilustrader.io/docs/api_reference/model/orders.html#module-nautilus_trader.model.orders.trailing_stop_market)
423+
[API Reference](../api_reference/model/orders.md#class-trailingstopmarketordertraderid-trader_id-strategyid-strategy_id-instrumentid-instrument_id-clientorderid-client_order_id-orderside-order_side-quantity-quantity-price-trigger_price-price--none-triggertype-trigger_type-trailing_offset-decimal-trailingoffsettype-trailing_offset_type-uuid4-init_id-uint64_t-ts_init-timeinforce-time_in_forcetimeinforcegtc-uint64_t-expire_time_ns0-bool-reduce_onlyfalse-bool-quote_quantityfalse-triggertype-emulation_triggertriggertypeno_trigger-instrumentid-trigger_instrument_idnone-contingencytype-contingency_typecontingencytypeno_contingency-orderlistid-order_list_idnone-list-linked_order_idsnone-clientorderid-parent_order_idnone-execalgorithmid-exec_algorithm_idnone-dict-exec_algorithm_paramsnone-clientorderid-exec_spawn_idnone-list-tagsnone)
422424

423425
### Trailing-Stop-Limit
424426

@@ -459,4 +461,4 @@ order: TrailingStopLimitOrder = self.order_factory.trailing_stop_limit(
459461
)
460462
```
461463

462-
[API Reference](https://nautilustrader.io/docs/api_reference/model/orders.html#module-nautilus_trader.model.orders.trailing_stop_limit)
464+
[API Reference](../api_reference/model/orders.md#class-trailingstoplimitordertraderid-trader_id-strategyid-strategy_id-instrumentid-instrument_id-clientorderid-client_order_id-orderside-order_side-quantity-quantity-price-price-price--none-price-trigger_price-price--none-triggertype-trigger_type-limit_offset-decimal-trailing_offset-decimal-trailingoffsettype-trailing_offset_type-uuid4-init_id-uint64_t-ts_init-timeinforce-time_in_forcetimeinforcegtc-uint64_t-expire_time_ns0-bool-post_onlyfalse-bool-reduce_onlyfalse-bool-quote_quantityfalse-quantity-display_qtynone-triggertype-emulation_triggertriggertypeno_trigger-instrumentid-trigger_instrument_idnone-contingencytype-contingency_typecontingencytypeno_contingency-orderlistid-order_list_idnone-list-linked_order_idsnone-clientorderid-parent_order_idnone-execalgorithmid-exec_algorithm_idnone-dict-exec_algorithm_paramsnone-clientorderid-exec_spawn_idnone-list-tagsnone)

docs/integrations/index.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ into a unified interface. The following integrations are currently supported:
66

77
| Name | ID | Type | Status | Docs |
88
| :-------------------------------------------------------- | :-------------------- | :---------------------- | :------------------------------------------------------ | :------------------------------------------------------------------ |
9-
| [Betfair](https://betfair.com) | `BETFAIR` | Sports Betting Exchange | ![status](https://img.shields.io/badge/stable-green) | [Guide](https://nautilustrader.io/docs/integrations/betfair.html) |
10-
| [Binance](https://binance.com) | `BINANCE` | Crypto Exchange (CEX) | ![status](https://img.shields.io/badge/stable-green) | [Guide](https://nautilustrader.io/docs/integrations/binance.html) |
11-
| [Binance US](https://binance.us) | `BINANCE` | Crypto Exchange (CEX) | ![status](https://img.shields.io/badge/stable-green) | [Guide](https://nautilustrader.io/docs/integrations/binance.html) |
12-
| [Binance Futures](https://www.binance.com/en/futures) | `BINANCE` | Crypto Exchange (CEX) | ![status](https://img.shields.io/badge/stable-green) | [Guide](https://nautilustrader.io/docs/integrations/binance.html) |
13-
| [Bybit](https://www.bybit.com) | `BYBIT` | Crypto Exchange (CEX) | ![status](https://img.shields.io/badge/beta-yellow) | [Guide](https://nautilustrader.io/docs/integrations/bybit.html) |
14-
| [Databento](https://databento.com) | `DATABENTO` | Data Provider | ![status](https://img.shields.io/badge/beta-yellow) | [Guide](https://nautilustrader.io/docs/integrations/databento.html) |
15-
| [Interactive Brokers](https://www.interactivebrokers.com) | `INTERACTIVE_BROKERS` | Brokerage (multi-venue) | ![status](https://img.shields.io/badge/stable-green) | [Guide](https://nautilustrader.io/docs/integrations/ib.html) |
9+
| [Betfair](https://betfair.com) | `BETFAIR` | Sports Betting Exchange | ![status](https://img.shields.io/badge/stable-green) | [Guide](betfair.md) |
10+
| [Binance](https://binance.com) | `BINANCE` | Crypto Exchange (CEX) | ![status](https://img.shields.io/badge/stable-green) | [Guide](binance.md) |
11+
| [Binance US](https://binance.us) | `BINANCE` | Crypto Exchange (CEX) | ![status](https://img.shields.io/badge/stable-green) | [Guide](binance.md) |
12+
| [Binance Futures](https://www.binance.com/en/futures) | `BINANCE` | Crypto Exchange (CEX) | ![status](https://img.shields.io/badge/stable-green) | [Guide](binance.md) |
13+
| [Bybit](https://www.bybit.com) | `BYBIT` | Crypto Exchange (CEX) | ![status](https://img.shields.io/badge/beta-yellow) | [Guide](bybit.md) |
14+
| [Databento](https://databento.com) | `DATABENTO` | Data Provider | ![status](https://img.shields.io/badge/beta-yellow) | [Guide](databento.md) |
15+
| [Interactive Brokers](https://www.interactivebrokers.com) | `INTERACTIVE_BROKERS` | Brokerage (multi-venue) | ![status](https://img.shields.io/badge/stable-green) | [Guide](ib.md) |
1616

1717
- `ID:` The default client ID for the integrations adapter clients
1818
- `Type:` The type of integration (often the venue type)

0 commit comments

Comments
 (0)