Refactor menu PIO IDE & CLI in docs

This commit is contained in:
Ivan Kravets
2016-10-29 22:07:25 +03:00
parent 5771a9e0f8
commit 7c4b1cedf7
7 changed files with 80 additions and 12 deletions

View File

@ -7,9 +7,13 @@ PlatformIO 3.0
3.2.0 (2016-??-??) 3.2.0 (2016-??-??)
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
* `PIO Remote™ <http://docs.platformio.org/en/latest/plus/pio-remote.html>`__.
Your devices are always with you!
* `PIO Account <http://docs.platformio.org/en/latest/userguide/account/index.html>`__
for extra professional features from `PlatformIO Plus <https://pioplus.com>`__
* Changed default exit combination for Device Monitor from ``Ctrl+]`` to ``Ctrl+C``
* Improved detecting of ARM mbed media disk for uploading * Improved detecting of ARM mbed media disk for uploading
* Improved Project Generator for CLion IDE when source folder contains nested items * Improved Project Generator for CLion IDE when source folder contains nested items
* Changed default exit combination for Device Monitor from ``Ctrl+]`` to ``Ctrl+C``
* Improved handling of library dependencies specified in ``library.json`` manifest * Improved handling of library dependencies specified in ``library.json`` manifest
(`issue #814 <https://github.com/platformio/platformio/issues/814>`_) (`issue #814 <https://github.com/platformio/platformio/issues/814>`_)
* Fixed issue with ``PATH`` auto-configuring for upload tools * Fixed issue with ``PATH`` auto-configuring for upload tools

22
docs/cli.rst Normal file
View File

@ -0,0 +1,22 @@
.. Copyright 2014-present PlatformIO <contact@platformio.org>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
.. _cli:
PlatformIO CLI
==============
.. toctree::
:maxdepth: 2
installation
quickstart
userguide/index

View File

@ -19,7 +19,8 @@ Demo & Projects
Project Examples Project Examples
---------------- ----------------
Pre-configured demo projects are located in `PlatformIO GitHub <https://github.com/platformio/platformio-examples/tree/develop>`_ repository. Pre-configured demo projects are located in PlatformIO GitHub repository
`https://github.com/platformio/platformio-examples <https://github.com/platformio/platformio-examples>`_.
"Blink Project" "Blink Project"
--------------- ---------------

View File

@ -11,13 +11,27 @@
.. _ide: .. _ide:
IDE Integration Cloud & Standalone IDE
=============== ======================
.. _ide_cloud:
Cloud IDE
---------
.. toctree::
:maxdepth: 2
ide/cloud9
.. _ide_standalone:
Standalone IDE
--------------
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
ide/atom
ide/clion ide/clion
ide/codeblocks ide/codeblocks
ide/eclipse ide/eclipse

28
docs/ide/cloud9.rst Normal file
View File

@ -0,0 +1,28 @@
.. Copyright 2014-present PlatformIO <contact@platformio.org>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
.. _ide_cloud9:
Cloud9
======
`Cloud9 <https://c9.io/>`_ combines a powerful online code editor with a full
Ubuntu workspace in the cloud.
Workspaces are powered by Docker Ubuntu containers that give you full freedom
over your environment, including sudo rights. Do a git push, compile SASS, see
server output, and Run apps easily with the built-in Terminal and Runners.
.. contents::
Integration
-----------
@TODO

View File

@ -93,9 +93,8 @@ Contents
:caption: Getting Started :caption: Getting Started
:maxdepth: 2 :maxdepth: 2
installation PlatformIO IDE <ide/atom>
quickstart cli
userguide/index
.. toctree:: .. toctree::
:caption: Configuration :caption: Configuration
@ -133,8 +132,8 @@ Contents
:caption: Integration :caption: Integration
:maxdepth: 2 :maxdepth: 2
ci/index
ide ide
ci/index
.. toctree:: .. toctree::
:caption: Miscellaneous :caption: Miscellaneous

View File

@ -11,8 +11,8 @@
.. _userguide: .. _userguide:
User Guide (CLI) User Guide
================ ==========
.. contents:: .. contents::
@ -21,8 +21,8 @@ Usage
.. code-block:: bash .. code-block:: bash
platformio [OPTIONS] COMMAND
pio [OPTIONS] COMMAND pio [OPTIONS] COMMAND
platformio [OPTIONS] COMMAND
# "pio" is the alias of "platformio" command # "pio" is the alias of "platformio" command