From 4f2c207bb32ebfb146e98d356f0ebb2b254553c7 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Tue, 2 Aug 2016 21:13:58 +0300 Subject: [PATCH] Use stable docs --- docs/ide/atom.rst | 30 +++++++++++++++--------------- docs/ide/clion.rst | 2 +- docs/ide/codeblocks.rst | 10 +++++----- docs/ide/eclipse.rst | 2 +- docs/ide/emacs.rst | 2 +- docs/ide/netbeans.rst | 2 +- docs/ide/qtcreator.rst | 16 ++++++++-------- docs/ide/sublimetext.rst | 2 +- docs/ide/visualstudio.rst | 6 +++--- docs/quickstart.rst | 2 +- platformio/__main__.py | 2 +- platformio/app.py | 2 +- platformio/commands/init.py | 8 ++++---- platformio/commands/lib.py | 2 +- platformio/commands/upgrade.py | 2 +- platformio/exception.py | 2 +- platformio/maintenance.py | 2 +- platformio/projectconftpl.ini | 2 +- platformio/util.py | 2 +- 19 files changed, 49 insertions(+), 49 deletions(-) diff --git a/docs/ide/atom.rst b/docs/ide/atom.rst index f3dc6c44..09c6692c 100644 --- a/docs/ide/atom.rst +++ b/docs/ide/atom.rst @@ -37,7 +37,7 @@ can customize to do anything but also use productively without ever touching a config file. .. image:: ../_static/ide-atom-platformio.png - :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio.png + :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio.png .. contents:: @@ -144,30 +144,30 @@ Setting Up the Project the corresponding icon in the PlatformIO toolbar as shown in the image below: .. image:: ../_static/ide-atom-platformio-quick-start-1.png - :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-1.png + :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-1.png 2. In the "New Project Menu" choose desired boards (more than one board is allowed) and select a project directory. Then press "Initialize" button: .. image:: ../_static/ide-atom-platformio-quick-start-2.png - :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-2.png + :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-2.png 3. If everything is fine, you should see the success message and project tree in the left panel: .. image:: ../_static/ide-atom-platformio-quick-start-3.png - :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-3.png + :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-3.png 4. Now, let's create the first project source file: right-click on the folder ``src`` and choose ``New File``: .. image:: ../_static/ide-atom-platformio-quick-start-4.png - :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-4.png + :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-4.png Enter filename ``main.cpp``: .. image:: ../_static/ide-atom-platformio-quick-start-5.png - :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-5.png + :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-5.png Copy the next source code to the just created file ``main.cpp``: @@ -209,13 +209,13 @@ upload firmware, run other targets) using: - :ref:`ide_atom_building_targets` and hotkeys .. image:: ../_static/ide-atom-platformio-quick-start-6.png - :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-6.png + :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-6.png 5. Run ``Build`` and you should see green "success" result in the building panel: .. image:: ../_static/ide-atom-platformio-quick-start-7.png - :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-7.png + :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-7.png To upload firmware to the board run ``Upload``. @@ -224,39 +224,39 @@ To upload firmware to the board run ``Upload``. or call targets list from the status bar (bottom, left corner): .. image:: ../_static/ide-atom-platformio-quick-start-8.png - :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-8.png + :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-8.png And select desired target: .. image:: ../_static/ide-atom-platformio-quick-start-9.png - :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-9.png + :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-9.png 7. To run built-in terminal interface choose ``Menu: PlatformIO > Terminal`` or press the corresponding icon in the PlatformIO toolbar: .. image:: ../_static/ide-atom-platformio-quick-start-10.png - :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-10.png + :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-10.png It provides you fast access to all set of powerful PlatformIO CLI commands: .. image:: ../_static/ide-atom-platformio-quick-start-11.png - :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-11.png + :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-11.png 8. To run built-in "Serial Monitor" choose ``Menu: PlatformIO > Serial Monitor`` or press the corresponding icon in the PlatformIO toolbar: .. image:: ../_static/ide-atom-platformio-quick-start-12.png - :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-12.png + :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-12.png It has several settings to adjust your connection: .. image:: ../_static/ide-atom-platformio-quick-start-13.png - :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-13.png + :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-13.png And allows you to communicate with your board in an easy way: .. image:: ../_static/ide-atom-platformio-quick-start-14.png - :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-14.png + :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-14.png User Guide diff --git a/docs/ide/clion.rst b/docs/ide/clion.rst index 7a548ee8..387dad92 100644 --- a/docs/ide/clion.rst +++ b/docs/ide/clion.rst @@ -24,7 +24,7 @@ Refer to the `CLion Documentation `_. .. image:: ../_static/ide-platformio-codeblocks.png - :target: http://docs.platformio.org/en/latest/_images/ide-platformio-codeblocks.png + :target: http://docs.platformio.org/en/stable/_images/ide-platformio-codeblocks.png .. contents:: diff --git a/docs/ide/eclipse.rst b/docs/ide/eclipse.rst index 2ef869f8..6f889b6b 100644 --- a/docs/ide/eclipse.rst +++ b/docs/ide/eclipse.rst @@ -28,7 +28,7 @@ Refer to the `CDT Documentation `_ page for more detailed information. .. image:: ../_static/ide-platformio-eclipse.png - :target: http://docs.platformio.org/en/latest/_static/ide-platformio-eclipse.png + :target: http://docs.platformio.org/en/stable/_static/ide-platformio-eclipse.png .. contents:: diff --git a/docs/ide/emacs.rst b/docs/ide/emacs.rst index 4a153c86..ef402dfb 100644 --- a/docs/ide/emacs.rst +++ b/docs/ide/emacs.rst @@ -23,7 +23,7 @@ Refer to the `Emacs Documentation ` page for more detailed information. .. image:: ../_static/ide-platformio-emacs.png - :target: http://docs.platformio.org/en/latest/_static/ide-platformio-emacs.png + :target: http://docs.platformio.org/en/stable/_static/ide-platformio-emacs.png .. contents:: diff --git a/docs/ide/netbeans.rst b/docs/ide/netbeans.rst index 6cba0b76..432ddb26 100644 --- a/docs/ide/netbeans.rst +++ b/docs/ide/netbeans.rst @@ -26,7 +26,7 @@ Just make sure you download the C/C++ version (or if you already use NetBeans, install the C/C++ development plugins). .. image:: ../_static/ide-platformio-netbeans.png - :target: http://docs.platformio.org/en/latest/_images/ide-platformio-netbeans.png + :target: http://docs.platformio.org/en/stable/_images/ide-platformio-netbeans.png .. contents:: diff --git a/docs/ide/qtcreator.rst b/docs/ide/qtcreator.rst index 79baddc6..83d3c259 100644 --- a/docs/ide/qtcreator.rst +++ b/docs/ide/qtcreator.rst @@ -20,7 +20,7 @@ Refer to the `Qt-creator Manual `_ page for more detailed information. .. image:: ../_static/ide-platformio-qtcreator-7.png - :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-7.png + :target: http://docs.platformio.org/en/stable/_static/ide-platformio-qtcreator-7.png .. contents:: @@ -83,7 +83,7 @@ Then: 8. Build project: ``Menu: Build > Build All``. .. image:: ../_static/ide-platformio-qtcreator-3.png - :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-3.png + :target: http://docs.platformio.org/en/stable/_static/ide-platformio-qtcreator-3.png .. warning:: The libraries which are added, installed or used in the project @@ -99,7 +99,7 @@ Setup New Project First of all, let's create new project from Qt Creator Start Page: ``New Project`` or using ``Menu: File > New File or Project``, then select project with ``Empty Qt Project`` type (``Other Project > Empty Qt Project``), fill ``Name``, ``Create in``. .. image:: ../_static/ide-platformio-qtcreator-1.png - :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-1.png + :target: http://docs.platformio.org/en/stable/_static/ide-platformio-qtcreator-1.png On the next steps select any available kit and click Finish button. @@ -108,7 +108,7 @@ On the next steps select any available kit and click Finish button. Secondly, we need to delete default build and clean steps and configure project with PlatformIO Build System (click on Projects label on left menu or ``Ctrl+5`` shortcut): .. image:: ../_static/ide-platformio-qtcreator-3.png - :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-3.png + :target: http://docs.platformio.org/en/stable/_static/ide-platformio-qtcreator-3.png Thirdly, change project file by adding path to directories with header files. Please edit project file to match the following contents: @@ -125,7 +125,7 @@ Thirdly, change project file by adding path to directories with header files. Pl INCLUDEPATH += "$${HOMEDIR}/.platformio/packages/toolchain-atmelavr/avr/include" .. image:: ../_static/ide-platformio-qtcreator-4.png - :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-4.png + :target: http://docs.platformio.org/en/stable/_static/ide-platformio-qtcreator-4.png First program in Qt Creator ~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -136,7 +136,7 @@ Simple "Blink" project will consist from two files: Let's create new text file named ``main.c`` using ``Menu: New File or Project > General > Text File``: .. image:: ../_static/ide-platformio-qtcreator-5.png - :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-5.png + :target: http://docs.platformio.org/en/stable/_static/ide-platformio-qtcreator-5.png Copy the source code which is described below to file ``main.c``. @@ -161,7 +161,7 @@ Copy the source code which is described below to file ``main.c``. 3. Locate the project configuration file named ``platformio.ini`` at the root of the project directory and open it. .. image:: ../_static/ide-platformio-qtcreator-6.png - :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-6.png + :target: http://docs.platformio.org/en/stable/_static/ide-platformio-qtcreator-6.png Edit the content to match the code described below. @@ -171,7 +171,7 @@ Edit the content to match the code described below. # Project Configuration File # # A detailed documentation with the EXAMPLES is located here: - # http://docs.platformio.org/en/latest/projectconf.html + # http://docs.platformio.org/en/stable/projectconf.html # # A sign `#` at the beginning of the line indicates a comment diff --git a/docs/ide/sublimetext.rst b/docs/ide/sublimetext.rst index 42d64bf4..78ae3292 100644 --- a/docs/ide/sublimetext.rst +++ b/docs/ide/sublimetext.rst @@ -170,7 +170,7 @@ Copy the source code which is described below to it. # Project Configuration File # # A detailed documentation with the EXAMPLES is located here: - # http://docs.platformio.org/en/latest/projectconf.html + # http://docs.platformio.org/en/stable/projectconf.html # # A sign `#` at the beginning of the line indicates a comment diff --git a/docs/ide/visualstudio.rst b/docs/ide/visualstudio.rst index 8d70dfbe..8bb5f1bf 100644 --- a/docs/ide/visualstudio.rst +++ b/docs/ide/visualstudio.rst @@ -20,7 +20,7 @@ Refer to the `Visual Studio Documentation `_ .. image:: ../_static/ide-vs-platformio-newproject-9.png - :target: http://docs.platformio.org/en/latest/_static/ide-vs-platformio-newproject-9.png + :target: http://docs.platformio.org/en/stable/_static/ide-vs-platformio-newproject-9.png diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 3b2d0c24..239586e0 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -150,7 +150,7 @@ The result of just generated ``platformio.ini``: # Project Configuration File # # A detailed documentation with the EXAMPLES is located here: - # http://docs.platformio.org/en/latest/projectconf.html + # http://docs.platformio.org/en/stable/projectconf.html # # A sign `#` at the beginning of the line indicates a comment diff --git a/platformio/__main__.py b/platformio/__main__.py index c553e8f6..d6ade4d6 100644 --- a/platformio/__main__.py +++ b/platformio/__main__.py @@ -122,7 +122,7 @@ An unexpected error occurred. Further steps: `pip install -U platformio` command * Try to find answer in FAQ Troubleshooting section - http://docs.platformio.org/en/latest/faq.html + http://docs.platformio.org/en/stable/faq.html * Report this problem to the developers https://github.com/platformio/platformio/issues diff --git a/platformio/app.py b/platformio/app.py index f7fcce2a..20f2f55e 100644 --- a/platformio/app.py +++ b/platformio/app.py @@ -46,7 +46,7 @@ DEFAULT_SETTINGS = { }, "enable_telemetry": { "description": ( - "Telemetry service (Yes/No)"), "value": True }, diff --git a/platformio/commands/init.py b/platformio/commands/init.py index 550e839c..6a9e964c 100644 --- a/platformio/commands/init.py +++ b/platformio/commands/init.py @@ -186,7 +186,7 @@ include paths and build them. See additional options for PlatformIO Library Dependency Finder `lib_*`: -http://docs.platformio.org/en/latest/projectconf.html#lib-install +http://docs.platformio.org/en/stable/projectconf.html#lib-install """) @@ -197,7 +197,7 @@ def init_ci_conf(project_dir): with open(join(project_dir, ".travis.yml"), "w") as f: f.write("""# Continuous Integration (CI) is the practice, in software # engineering, of merging all developer working copies with a shared mainline -# several times a day < http://docs.platformio.org/en/latest/ci/index.html > +# several times a day < http://docs.platformio.org/en/stable/ci/index.html > # # Documentation: # @@ -205,10 +205,10 @@ def init_ci_conf(project_dir): # < https://docs.travis-ci.com/user/integration/platformio/ > # # * PlatformIO integration with Travis CI -# < http://docs.platformio.org/en/latest/ci/travis.html > +# < http://docs.platformio.org/en/stable/ci/travis.html > # # * User Guide for `platformio ci` command -# < http://docs.platformio.org/en/latest/userguide/cmd_ci.html > +# < http://docs.platformio.org/en/stable/userguide/cmd_ci.html > # # # Please choice one of the following templates (proposed below) and uncomment diff --git a/platformio/commands/lib.py b/platformio/commands/lib.py index bbf8bb09..b48b23dc 100644 --- a/platformio/commands/lib.py +++ b/platformio/commands/lib.py @@ -90,7 +90,7 @@ def lib_search(query, json_output, page, **filters): click.echo("For more examples and advanced search syntax, " "please use documentation:") click.secho("http://docs.platformio.org" - "/en/latest/userguide/lib/cmd_search.html\n", fg="cyan") + "/en/stable/userguide/lib/cmd_search.html\n", fg="cyan") return click.secho("Found %d libraries:\n" % result['total'], diff --git a/platformio/commands/upgrade.py b/platformio/commands/upgrade.py index 44e3b8ea..24676bf1 100644 --- a/platformio/commands/upgrade.py +++ b/platformio/commands/upgrade.py @@ -70,7 +70,7 @@ def cli(): "PlatformIO has been successfully upgraded to %s" % actual_version, fg="green") click.echo("Release notes: ", nl=False) - click.secho("http://docs.platformio.org/en/latest/history.html", + click.secho("http://docs.platformio.org/en/stable/history.html", fg="cyan") except Exception as e: # pylint: disable=W0703 if not r: diff --git a/platformio/exception.py b/platformio/exception.py index 78059eb2..07fa0248 100644 --- a/platformio/exception.py +++ b/platformio/exception.py @@ -191,7 +191,7 @@ class UpgradeError(PlatformioException): * Upgrade using `pip install -U platformio` * Try different installation/upgrading steps: - http://docs.platformio.org/en/latest/installation.html + http://docs.platformio.org/en/stable/installation.html """ diff --git a/platformio/maintenance.py b/platformio/maintenance.py index d2e944eb..4832793d 100644 --- a/platformio/maintenance.py +++ b/platformio/maintenance.py @@ -217,7 +217,7 @@ def check_platformio_upgrade(): click.secho("pip install -U platformio", fg="cyan", nl=False) click.secho("` command.", fg="yellow") click.secho("Changes: ", fg="yellow", nl=False) - click.secho("http://docs.platformio.org/en/latest/history.html", + click.secho("http://docs.platformio.org/en/stable/history.html", fg="cyan") click.echo("*" * terminal_width) click.echo("") diff --git a/platformio/projectconftpl.ini b/platformio/projectconftpl.ini index da48cf88..fd754591 100644 --- a/platformio/projectconftpl.ini +++ b/platformio/projectconftpl.ini @@ -2,7 +2,7 @@ # Project Configuration File # # A detailed documentation with the EXAMPLES is located here: -# http://docs.platformio.org/en/latest/projectconf.html +# http://docs.platformio.org/en/stable/projectconf.html # # A sign `#` at the beginning of the line indicates a comment diff --git a/platformio/util.py b/platformio/util.py index 727c9957..f5e96b20 100644 --- a/platformio/util.py +++ b/platformio/util.py @@ -224,7 +224,7 @@ def get_pioenvs_dir(): with open(dontmod_path, "w") as fp: fp.write(""" [InternetShortcut] -URL=http://docs.platformio.org/en/latest/projectconf.html#envs-dir +URL=http://docs.platformio.org/en/stable/projectconf.html#envs-dir """) return path