From a3ce23e3312cf0778f7a93fb094ebf556188896e Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Mon, 19 Sep 2016 21:02:12 +0300 Subject: [PATCH] Improvements to docs --- docs/demo.rst | 2 +- docs/librarymanager/index.rst | 10 ++++++---- docs/userguide/lib/cmd_install.rst | 2 +- docs/userguide/lib/cmd_list.rst | 2 +- docs/userguide/lib/cmd_show.rst | 2 +- docs/userguide/lib/cmd_uninstall.rst | 2 +- docs/userguide/lib/cmd_update.rst | 2 +- docs/userguide/lib/index.rst | 4 ++-- 8 files changed, 14 insertions(+), 12 deletions(-) diff --git a/docs/demo.rst b/docs/demo.rst index b44a2c69..fe828233 100644 --- a/docs/demo.rst +++ b/docs/demo.rst @@ -55,7 +55,7 @@ Library Manager Used in demo ~~~~~~~~~~~~ -1. :ref:`userguide_lib` +1. :ref:`cmd_lib` 2. :ref:`platformio lib search 1-wire ` command 3. :ref:`platformio lib install 54 ` command 4. :ref:`platformio lib search -f mbed ` command diff --git a/docs/librarymanager/index.rst b/docs/librarymanager/index.rst index 52d8ec87..df03b8b4 100644 --- a/docs/librarymanager/index.rst +++ b/docs/librarymanager/index.rst @@ -20,14 +20,16 @@ Hg, SVN). It makes it exceedingly simple to find, install and keep libraries up-to-date. PlatformIO Library Manager supports `Semantic Versioning `_ and its rules. -There 2 options how to find library: +There are 2 options how to find library: +* `Web Library Search `__ * :ref:`Command Line Interface ` -* `Web-based Library Search `__ -*PlatformIO Library Manager* allows to manage different library storages using +You can manage different library storages using :option:`platformio lib --global` or :option:`platformio lib --storage-dir` -options. +options. If you change current working directory in terminal to project folder, +then :ref:`platformio lib ` command will manage automatically dependency +storage in :ref:`projectconf_pio_libdeps_dir`. Project dependencies -------------------- diff --git a/docs/userguide/lib/cmd_install.rst b/docs/userguide/lib/cmd_install.rst index d407d935..35bb6c2f 100644 --- a/docs/userguide/lib/cmd_install.rst +++ b/docs/userguide/lib/cmd_install.rst @@ -87,7 +87,7 @@ archive should contain ``.library.json`` manifest (see :ref:`library_config`). Storage Options --------------- -See base options for :ref:`userguide_lib`. +See base options for :ref:`cmd_lib`. Options ------- diff --git a/docs/userguide/lib/cmd_list.rst b/docs/userguide/lib/cmd_list.rst index b0274fc7..ad5e070b 100644 --- a/docs/userguide/lib/cmd_list.rst +++ b/docs/userguide/lib/cmd_list.rst @@ -43,7 +43,7 @@ List installed libraries Storage Options --------------- -See base options for :ref:`userguide_lib`. +See base options for :ref:`cmd_lib`. Options ~~~~~~~ diff --git a/docs/userguide/lib/cmd_show.rst b/docs/userguide/lib/cmd_show.rst index b0befe1d..d93b38a9 100644 --- a/docs/userguide/lib/cmd_show.rst +++ b/docs/userguide/lib/cmd_show.rst @@ -64,7 +64,7 @@ The ``version`` supports `Semantic Versioning `_ ( Storage Options --------------- -See base options for :ref:`userguide_lib`. +See base options for :ref:`cmd_lib`. Examples -------- diff --git a/docs/userguide/lib/cmd_uninstall.rst b/docs/userguide/lib/cmd_uninstall.rst index a465ad17..eea9a074 100644 --- a/docs/userguide/lib/cmd_uninstall.rst +++ b/docs/userguide/lib/cmd_uninstall.rst @@ -63,7 +63,7 @@ The ``version`` supports `Semantic Versioning `_ ( Storage Options --------------- -See base options for :ref:`userguide_lib`. +See base options for :ref:`cmd_lib`. Examples -------- diff --git a/docs/userguide/lib/cmd_update.rst b/docs/userguide/lib/cmd_update.rst index aea28cf0..dc2e1ec9 100644 --- a/docs/userguide/lib/cmd_update.rst +++ b/docs/userguide/lib/cmd_update.rst @@ -67,7 +67,7 @@ The ``version`` supports `Semantic Versioning `_ ( Storage Options --------------- -See base options for :ref:`userguide_lib`. +See base options for :ref:`cmd_lib`. Options ------- diff --git a/docs/userguide/lib/index.rst b/docs/userguide/lib/index.rst index d0722ab7..8a4c157a 100644 --- a/docs/userguide/lib/index.rst +++ b/docs/userguide/lib/index.rst @@ -9,7 +9,7 @@ See the License for the specific language governing permissions and limitations under the License. -.. _userguide_lib: +.. _cmd_lib: Library Manager =============== @@ -46,7 +46,7 @@ dependencies by default. .. versionadded:: 3.0 Manage custom library storage. It can be used later for the -:ref:`projectconf_extra_script` option from :ref:`projectconf`. +:ref:`projectconf_lib_extra_dirs` option from :ref:`projectconf`. Demo ----