platformio/platformio-core
1
0
Fork 1
mirror of https://github.com/platformio/platformio-core.git synced 2025-07-30 01:57:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improvements to docs

Browse Source
This commit is contained in:
Ivan Kravets
2016-09-19 21:02:12 +03:00
parent 6147e0e29b
commit a3ce23e331
8 changed files with 14 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/demo.rst
View File

@ -55,7 +55,7 @@ Library Manager
Used in demo Used in demo
~~~~~~~~~~~~ ~~~~~~~~~~~~
1. :ref:`userguide_lib` 1. :ref:`cmd_lib`
2. :ref:`platformio lib search 1-wire <cmd_lib_search>` command 2. :ref:`platformio lib search 1-wire <cmd_lib_search>` command
3. :ref:`platformio lib install 54 <cmd_lib_install>` command 3. :ref:`platformio lib install 54 <cmd_lib_install>` command
4. :ref:`platformio lib search -f mbed <cmd_lib_search>` command 4. :ref:`platformio lib search -f mbed <cmd_lib_search>` command

10
docs/librarymanager/index.rst
View File

@ -20,14 +20,16 @@ Hg, SVN). It makes it exceedingly simple to find, install and keep libraries
up-to-date. PlatformIO Library Manager supports up-to-date. PlatformIO Library Manager supports
`Semantic Versioning <http://semver.org>`_ and its rules. `Semantic Versioning <http://semver.org>`_ and its rules.
There 2 options how to find library: There are 2 options how to find library:
* `Web Library Search <http://platformio.org/lib>`__
* :ref:`Command Line Interface <cmd_lib_search>` * :ref:`Command Line Interface <cmd_lib_search>`
* `Web-based Library Search <http://platformio.org/lib>`__
*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` :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 <cmd_lib>` command will manage automatically dependency
storage in :ref:`projectconf_pio_libdeps_dir`.
Project dependencies Project dependencies
-------------------- --------------------

2
docs/userguide/lib/cmd_install.rst
View File

@ -87,7 +87,7 @@ archive should contain ``.library.json`` manifest (see :ref:`library_config`).
Storage Options Storage Options
--------------- ---------------
See base options for :ref:`userguide_lib`. See base options for :ref:`cmd_lib`.
Options Options
------- -------

2
docs/userguide/lib/cmd_list.rst
View File

@ -43,7 +43,7 @@ List installed libraries
Storage Options Storage Options
--------------- ---------------
See base options for :ref:`userguide_lib`. See base options for :ref:`cmd_lib`.
Options Options
~~~~~~~ ~~~~~~~

2
docs/userguide/lib/cmd_show.rst
View File

@ -64,7 +64,7 @@ The ``version`` supports `Semantic Versioning <http://semver.org>`_ (
Storage Options Storage Options
--------------- ---------------
See base options for :ref:`userguide_lib`. See base options for :ref:`cmd_lib`.
Examples Examples
-------- --------

2
docs/userguide/lib/cmd_uninstall.rst
View File

@ -63,7 +63,7 @@ The ``version`` supports `Semantic Versioning <http://semver.org>`_ (
Storage Options Storage Options
--------------- ---------------
See base options for :ref:`userguide_lib`. See base options for :ref:`cmd_lib`.
Examples Examples
-------- --------

2
docs/userguide/lib/cmd_update.rst
View File

@ -67,7 +67,7 @@ The ``version`` supports `Semantic Versioning <http://semver.org>`_ (
Storage Options Storage Options
--------------- ---------------
See base options for :ref:`userguide_lib`. See base options for :ref:`cmd_lib`.
Options Options
------- -------

4
docs/userguide/lib/index.rst
View File

@ -9,7 +9,7 @@
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
.. _userguide_lib: .. _cmd_lib:
Library Manager Library Manager
=============== ===============
@ -46,7 +46,7 @@ dependencies by default.
.. versionadded:: 3.0 .. versionadded:: 3.0
Manage custom library storage. It can be used later for the 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 Demo
---- ----