From 7c4b1cedf7cd69e8c3615ed9fabe8bde4883fe4f Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Sat, 29 Oct 2016 22:07:25 +0300 Subject: [PATCH] Refactor menu PIO IDE & CLI in docs --- HISTORY.rst | 6 +++++- docs/cli.rst | 22 ++++++++++++++++++++++ docs/demo.rst | 3 ++- docs/ide.rst | 20 +++++++++++++++++--- docs/ide/cloud9.rst | 28 ++++++++++++++++++++++++++++ docs/index.rst | 7 +++---- docs/userguide/index.rst | 6 +++--- 7 files changed, 80 insertions(+), 12 deletions(-) create mode 100644 docs/cli.rst create mode 100644 docs/ide/cloud9.rst diff --git a/HISTORY.rst b/HISTORY.rst index bfccddfc..dbc608b8 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -7,9 +7,13 @@ PlatformIO 3.0 3.2.0 (2016-??-??) ~~~~~~~~~~~~~~~~~~ +* `PIO Remote™ `__. + Your devices are always with you! +* `PIO Account `__ + for extra professional features from `PlatformIO Plus `__ +* Changed default exit combination for Device Monitor from ``Ctrl+]`` to ``Ctrl+C`` * Improved detecting of ARM mbed media disk for uploading * 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 (`issue #814 `_) * Fixed issue with ``PATH`` auto-configuring for upload tools diff --git a/docs/cli.rst b/docs/cli.rst new file mode 100644 index 00000000..f740401f --- /dev/null +++ b/docs/cli.rst @@ -0,0 +1,22 @@ +.. Copyright 2014-present PlatformIO + 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 diff --git a/docs/demo.rst b/docs/demo.rst index fe828233..7e535991 100644 --- a/docs/demo.rst +++ b/docs/demo.rst @@ -19,7 +19,8 @@ Demo & Projects Project Examples ---------------- -Pre-configured demo projects are located in `PlatformIO GitHub `_ repository. +Pre-configured demo projects are located in PlatformIO GitHub repository +`https://github.com/platformio/platformio-examples `_. "Blink Project" --------------- diff --git a/docs/ide.rst b/docs/ide.rst index f41e3643..ce348e6e 100644 --- a/docs/ide.rst +++ b/docs/ide.rst @@ -11,13 +11,27 @@ .. _ide: -IDE Integration -=============== +Cloud & Standalone IDE +====================== + +.. _ide_cloud: + +Cloud IDE +--------- + +.. toctree:: + :maxdepth: 2 + + ide/cloud9 + +.. _ide_standalone: + +Standalone IDE +-------------- .. toctree:: :maxdepth: 2 - ide/atom ide/clion ide/codeblocks ide/eclipse diff --git a/docs/ide/cloud9.rst b/docs/ide/cloud9.rst new file mode 100644 index 00000000..c3f7535f --- /dev/null +++ b/docs/ide/cloud9.rst @@ -0,0 +1,28 @@ +.. Copyright 2014-present PlatformIO + 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 `_ 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 \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index d9957bf7..3c10f7d9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -93,9 +93,8 @@ Contents :caption: Getting Started :maxdepth: 2 - installation - quickstart - userguide/index + PlatformIO IDE + cli .. toctree:: :caption: Configuration @@ -133,8 +132,8 @@ Contents :caption: Integration :maxdepth: 2 - ci/index ide + ci/index .. toctree:: :caption: Miscellaneous diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index d687f1a0..b5994025 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -11,8 +11,8 @@ .. _userguide: -User Guide (CLI) -================ +User Guide +========== .. contents:: @@ -21,8 +21,8 @@ Usage .. code-block:: bash - platformio [OPTIONS] COMMAND pio [OPTIONS] COMMAND + platformio [OPTIONS] COMMAND # "pio" is the alias of "platformio" command