Pine Script documentation
How to build html docs
Follow these steps:
sudo make install_tools
make syncpackages(this would download the theme)
Your docs will be in the
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,
For example such a content:
Expressions, declarations and statements ========================================
Should be saved on disk as
Automatic table of contents
Use reStructuredText directive
contents. Place it after the title of a section, which table of contents you want.
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.
Special unicode characters
There is a set of macros in file isonum.txt.
For example for → (RIGHTWARDS ARROW) use
.. include:: <isonum.txt> Indicators |rarr| Built-ins