https://github.com/tradingview/rest_integrations_docs

https://github.com/tradingview/rest_integrations_docs

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/tradingview/rest_integrations_docs
• Owner: tradingview
• Created: 2021-07-28T13:32:50.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-08-08T09:02:39.000Z (over 1 year ago)
• Last Synced: 2024-11-01T11:34:48.485Z (12 days ago)
• Language: Python
• Size: 6.93 MB
• Stars: 7
• Watchers: 5
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# REST Integrations FAQ

## How to build docs

Follow these steps:

* Execute `make init`

* Execute `make doc`

Your docs will be in the `build/html` folder.

## How to build docs in watch mode

* Execute `make watch`

Docs will be available at http://localhost:8000

## Troubleshooting

If you encounter errors make sure you have Python 3.10 installed and run in the project directory in the console `rm -rf venv` before `make init`

## Notes for writers

### Rules for capitalization in titles

* Capitalize the first word of the title

* Capitalize all proper nouns

### Filenames for *.rst files

Take a page title, replace all spaces with underscores (`_`), remove all punctuation (except dashes, `-`), add `.rst` extension.

For example such a content:

```

Expressions, declarations and statements

========================================

```

Should be saved on disk as `Expressions_declarations_and_statements.rst`.

### Automatic table of contents

Use reStructuredText directive `contents`. Place it after the title of a section, which table of contents you want.

For example:

```

Expressions, declarations and statements

========================================

.. contents:: :local:

    :depth: 2

```

### Quotation marks

Documentation uses American style which considers a double quotes are the default ones. Single quotes are used if nested in the double ones. For example: 

* Joe said, "Will you marry me?"

* Joe smiled and said, "Jenny said 'yes' when I asked her to marry me."

### Inline markup

* One asterisk: `*text*` for emphasis (italics),

* Two asterisks: `**text**` for strong emphasis (boldface), and

* Two backquotes: ``text`` for inline code samples.

### Special unicode characters

There is a set of macros in file [isonum.txt](http://docutils.sourceforge.net/docs/ref/rst/definitions.html).

For example for → (RIGHTWARDS ARROW) use `|rarr|` macro. 

For example:

```

..    include:: 

Indicators |rarr| Built-ins

```