Public documentation for TempoIQ. Officially hosted at https://developers.tempoiq.com/docs/
To build docs locally:
git clone <this repo>cd docs/- (optional) Switch into a Python virtualenv
pip install -r requirements.txtmake html
HTML output is in build/html. If you're feeling more adventurous, there's also a Grunt task that auto-builds the docs and refreshes the webpage whenever a .rst file changes. To set it up:
- Install Node: e.g.
brew install node - Install grunt:
npm install -g grunt-cli - Install packages and grunt plugins to do the cool stuff:
npm install - Run the task with
grunt.
The "dev" Sphinx tag can be used to include content in development builds only, e.g.:
.. only:: dev
Insert profanity, secrets, or other content that shouldn't be included
in published docs.
The todo directive already has this behavior, so todos are never present in production docs.
Example code snippets can be included from files in this repo, or from remote GitHub respositories. This will be used in the future to tie example code to our client libraries, to enable integration testing the examples. See source/sphinxext/snippets.py for more information.
The FAQs page (/source/faqs.rst) can be used as a temporary holding area for quickly answering questions that come up from customers. However, the page should periodically be refactored, putting answers into more specific pages to prevent it from sprawling out of control.
Use the following hierarchy for indicating headings in .rst:
h1:
============
Page heading
============
h2:
Section heading
---------------
h3:
Subsection heading
~~~~~~~~~~~~~~~~~~
h4 (but try to avoid hierarchies this deep):
Sub-subsection heading
^^^^^^^^^^^^^^^^^^^^^^
- "data point" is two words
- "time zone" is two words
- "realtime", not "real time" or "real-time"
- "timestamp" is one word
- Use the oxford comma.
- File names should be in
kebab-case - Class names should be in
PascalCase(except in filenames). - To reflect the JSON API, multi-word field names should be in
snake_case.