Tago Ecosystem Documentation
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_backup
_static
_templates
locale/pt/LC_MESSAGES
.gitignore
Makefile
README.md
account.rst
actions.rst
analysis.rst
api.rst
concepts.rst
conf.py
dashboard.rst
getstarted.rst
index.rst
make.bat
mastering-vim.pdf
mqtt.rst
notifications.rst
sdk.rst
sigfox.rst
tutorials.rst

README.md

Tago Documentation

Requirements

To install python on a Mac with brew (it comes with Pip)

$ brew install python

To install Sphinx and sphinx-intl

$ pip install Sphinx $ pip install sphinx-intl $ pip install sphinx_rtd_theme

Editing

Every menu entry has a file matching it's name with the .rst extension. So to add or remove documentations just edit those files.

Generating the HTML

$ make html

The HTML will be in the _build/html/ folder. Just open the index.html to visualize the documentation.

reStructuredText syntax docs

resStructuredText syntax differs from Markdown in many ways, you can use the following docs to support you.

http://sphinx-doc.org/rest.html

http://sphinx-doc.org/markup/index.html

Please note that the titles in each .rst file are responsible for creating the sub menus in the sidebar. To fully understand how this works, I recommend you to read this article before creating your docs: http://sphinx-doc.org/rest.html#sections