This repo contains the source for the current User Manual of TradingView's Pine programming language. It deprecates the Pine Tutorial Wiki. The source uses reStructuredText markup and we use Sphynx to build the final HTML product.
Follow these steps:
- Execute
sudo make install_tools
- Execute
make syncpackages
(this would download the theme) - Execute
make html
Your docs will be in the build/html
folder.
- Capitalize the first word of the title
- Capitalize all proper nouns
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
.
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
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."
- One asterisk:
*text*
for emphasis (italics), - Two asterisks:
**text**
for strong emphasis (boldface), and - Two backquotes: ``text`` for inline code samples.
There is a set of macros in file isonum.txt.
For example for โ (RIGHTWARDS ARROW) use |rarr|
macro.
For example:
.. include:: <isonum.txt>
Indicators |rarr| Built-ins