Merge pull request readthedocs#5161 from rexzing/guilabel-reformatting

Docs reformatting with :guilabel:

Author: ericholscher

docs/advertising/ethical-advertising.rst

@@ -154,15 +154,14 @@ or a `Supporter <https://readthedocs.org/sustainability/#donations>`_.
 
 Users can opt out of seeing paid advertisements on documentation pages:
 
-* Go to the drop down user menu in the top right of the Read the Docs dashboard and clicking **Settings** (https://readthedocs.org/accounts/edit/).
-* On the **Advertising** tab, you can deselect **See paid advertising**.
+* Go to the drop down user menu in the top right of the Read the Docs dashboard and clicking :guilabel:`Settings` (https://readthedocs.org/accounts/edit/).
+* On the :guilabel:`Advertising` tab, you can deselect **See paid advertising**.
 
 Project owners can also opt out of paid advertisements for their projects.
 You can change these options:
 
-* Click on your **Project** page (`/projects/<slug>/`)
-* Click the  **Admin** dashboard link 
-* Choose the **Advertising** submenu on the left side
+* Go to your **project** page (`/projects/<slug>/`)
+* Go to :guilabel:`Admin` > :guilabel:`Advertising`
 * Change your advertising settings
 
 Project opt out options include:

docs/canonical.rst

@@ -15,15 +15,18 @@ Example
 
 Fabric hosts their docs on Read the Docs.
 They mostly use their own domain for them ``http://docs.fabfile.org``.
-This means that Google will index both ``http://fabric-docs.readthedocs.io`` and ``http://docs.fabfile.org`` for their documentation.
+This means that Google will index both ``http://fabric-docs.readthedocs.io`` and
+``http://docs.fabfile.org`` for their documentation.
 
 Fabric will want to set ``http://docs.fabfile.org`` as their canonical URL.
-This means that when Google indexes ``http://fabric-docs.readthedocs.io``, it will know that it should really point at ``http://docs.fabfile.org``.
+This means that when Google indexes ``http://fabric-docs.readthedocs.io``,
+it will know that it should really point at ``http://docs.fabfile.org``.
 
 Enabling
 --------
 
-You can set the canonical URL for your project in the Project Admin page. Check your `Domains` tab for the domains that we know about.
+You can set the canonical URL for your project in the Project Admin page.
+Check your :guilabel:`Admin` > :guilabel:`Domains` page for the domains that we know about.
 
 Implementation
 --------------

docs/commercial/custom_domains.rst

@@ -19,8 +19,8 @@ you can still host with us.
 We require two steps from your side:
 
 * Add a CNAME record in your DNS that points to our servers ``<organization-slug>.users.readthedocs.com``
-* Set your project's Privacy Level to *Public* from **Project Admin > Advance Settings**.
-* Add a Domain in the **Project Admin > Domains** page for your project.
+* Set your project's Privacy Level to *Public* from :guilabel:`Admin` > :guilabel:`Advance Settings`.
+* Add a Domain in the :guilabel:`Admin` > :guilabel:`Domains` page for your project.
 
 .. note:: The domain that should be used is the actual subdomain that you want your docs served on.
           Generally it will be ``docs.projectname.com``.

docs/custom_installs/local_rtd_vm.rst

@@ -160,7 +160,7 @@ Log into ``http://[VM IP ADDRESS]:[PORT]`` using the django superuser creds and
 For a new project
 `````````````````
 
-1. Select **<username> > Add Project** from the user menu.
+1. Select :guilabel:`<username>` > :guilabel:`Add Project` from the user menu.
 2. Click **Manually Import Project**.
 3. Provide the following information in the **Project Details** page:
 
@@ -174,7 +174,7 @@ For a new project
 For an existing project
 ```````````````````````
 
-1. Select **<username> > Projects** from the user menu.
+1. Select :guilabel:`<username>` > :guilabel:`Projects` from the user menu.
 2. Select the relevant project from the **Projects** list.
 3. Select latest from the **Build a version** dropdown.
 4. Click **Build**. This will take you to the Builds tab where the progress status is displayed. This may take some time.

docs/guides/build-notifications.rst

@@ -9,7 +9,7 @@ This makes sure you know when your builds have failed.
 
 Take these steps to enable build notifications using email:
 
-* Go to **Admin > Notifications** in your project.
+* Go to :guilabel:`Admin` > :guilabel:`Notifications` in your project.
 * Fill in the **Email** field under the **New Email Notifications** heading
 * Submit the form
 
@@ -22,7 +22,7 @@ Read the Docs can also send webhooks when builds fail.
 
 Take these steps to enable build notifications using a webhook:
 
-* Go to **Admin > Notifications** in your project.
+* Go to :guilabel:`Admin` > :guilabel:`Notifications` in your project.
 * Fill in the **URL** field under the **New Webhook Notifications** heading
 * Submit the form
 

docs/guides/environment-variables.rst

@@ -9,16 +9,18 @@ All these variables will be exposed to all the commands executed when building y
 
 To define an environment variable, you need to
 
-#. Go to your project **Admin > Environment Variables**
+#. Go to your project :guilabel:`Admin` > :guilabel:`Environment Variables`
 #. Click on "Add Environment Variable" button
 #. Input a ``Name`` and ``Value`` (your secret needed here)
 #. Click "Save" button
 
 .. note::
 
-   Values will never be exposed to users, even to owners of the project. Once you create an environment variable you won't be able to see its value anymore because of security purposes.
+   Values will never be exposed to users, even to owners of the project.
+   Once you create an environment variable you won't be able to see its value anymore because of security purposes.
 
-After adding an environment variable from your project's admin, you can access it from your build process using Python, for example:
+After adding an environment variable from your project's admin, you can access it from your build process using Python,
+for example:
 
 .. code-block:: python
 

docs/guides/google-analytics.rst

@@ -4,7 +4,7 @@ Enabling Google Analytics on your Project
 Read the Docs has native support for Google Analytics.
 You can enable it by:
 
-* Going to **Admin > Advanced Settings** in your project.
+* Going to :guilabel:`Admin` > :guilabel:`Advanced Settings` in your project.
 * Fill in the **Analytics code** heading with your Google Tracking ID (example `UA-123456674-1`)
 
 Once your documentation rebuilds it will include your Analytics tracking code and start sending data.

docs/guides/wipe-environment.rst

@@ -12,7 +12,7 @@ Docs to create a new fresh one.
 
 Follow these steps to wipe the build environment:
 
-* Go to **Versions**
+* Go to :guilabel:`Versions`
 * Click on the **Edit** button of the version you want to wipe on the
   right side of the page
 * Go to the bottom of the page and click the **wipe** link, next to

docs/intro/import-guide.rst

@@ -42,7 +42,7 @@ Add an optional homepage URL and some tags, and then click **Next**.
 
 Once your project is created, you'll need to manually configure the repository
 webhook if you would like to have new changes trigger builds for your
-project on Read the Docs. Go to your project's **Integrations** page to
+project on Read the Docs. Go to your project's :guilabel:`Admin` > :guilabel:`Integrations` page to
 configure a new webhook, or see :ref:`our steps for webhook creation <webhooks:Webhook Creation>`
 for more information on this process.
 

docs/single_version.rst

@@ -12,13 +12,17 @@ You can see a live example of this at http://www.contribution-guide.org
 Enabling
 ~~~~~~~~
 
-You can toggle the "Single Version" option on or off for your project in the Project Admin page. Check your `dashboard`_ for a list of your projects.
+You can toggle the "Single Version" option on or off for your project in the Project Admin page.
+Check your :guilabel:`dashboard` for a list of your projects.
 
 Effects
 ~~~~~~~
 
-Links generated on Read the Docs will now point to the proper URL. For example, if pip was set as a "Single Version" project, then links to its documentation would point to ``http://pip.readthedocs.io/`` rather than the default ``http://pip.readthedocs.io/en/latest/``.
+Links generated on Read the Docs will now point to the proper URL. For example,
+if pip was set as a "Single Version" project, then links to its documentation would point to
+``http://pip.readthedocs.io/`` rather than the default ``http://pip.readthedocs.io/en/latest/``.
 
-Documentation at ``/<language>/<default_version>/`` will still be served for backwards compatibility reasons. However, our usage of :doc:`canonical` should stop these from being indexed by Google.
+Documentation at ``/<language>/<default_version>/`` will still be served for backwards compatibility reasons.
+However, our usage of :doc:`canonical` should stop these from being indexed by Google.
 
 .. _dashboard: https://readthedocs.org/dashboard/

docs/versions.rst

@@ -63,4 +63,4 @@ This is a banner that appears on the top of every page of your docs that aren't
 This banner has a text with a link redirecting the users to the latest version of your docs.
 
 This feature is disabled by default on new projects,
-you can enable it in the admin section of your docs (Advanced Settings).
+you can enable it in the admin section of your docs (:guilabel:`Admin` > :guilabel:`Advanced Settings`).

docs/webhooks.rst

@@ -30,9 +30,9 @@ a webhook will be set up automatically for your repository. However, if your
 project was not imported through a connected account, you may need to
 manually configure a webhook for your project.
 
-To manually set up a webhook, click **Add integration** on your project's
-**Integrations** Admin dashboard page and select the integration type you'd like
-to add. After you have added the integration, you'll see a link to information about the integration.
+To manually set up a webhook, go to :guilabel:`Admin` > :guilabel:`Integrations` >  :guilabel:`Add integration`
+dashboard page and select the integration type you'd like to add.
+After you have added the integration, you'll see a link to information about the integration.
 
 As an example, the URL pattern looks like this: *readthedocs.org/api/v2/webhook/<project-name>/<id>/*.
 
@@ -43,18 +43,20 @@ Use this URL when setting up a new webhook with your provider -- these steps var
 GitHub
 ~~~~~~
 
-* Go to the **Settings** page for your project
-* Click **Webhooks** and then **Add webhook**
+* Go to the :guilabel:`Settings` page for your project
+* Click :guilabel:`Webhooks` > :guilabel:`Add webhook`
 * For **Payload URL**, use the URL of the integration on Read the Docs,
-  found on the project's **Integrations** Admin dashboard page. You may need to prepend *https://* to the URL.
+  found on the project's :guilabel:`Admin` > :guilabel:`Integrations` page.
+  You may need to prepend *https://* to the URL.
 * For **Content type**, both *application/json* and
   *application/x-www-form-urlencoded* work
 * Select **Let me select individual events**,
   and mark **Pushes**, **Branch or tag creation**, and **Branch or tag deletion** events
 * Leave the **Secrets** field black
 * Finish by clicking **Add webhook**
 
-You can verify if the webhook is working at the bottom of the GitHub page under **Recent Deliveries**. If you see a Response 200, then the webhook is correctly configured.
+You can verify if the webhook is working at the bottom of the GitHub page under **Recent Deliveries**.
+If you see a Response 200, then the webhook is correctly configured.
 For a 403 error, it's likely that the Payload URL is incorrect.
 
 .. note:: The webhook token, intended for the GitHub **Secret** field, is not yet implemented.
@@ -64,10 +66,9 @@ For a 403 error, it's likely that the Payload URL is incorrect.
 Bitbucket
 ~~~~~~~~~
 
-* Go to the **Settings** page for your project
-* Click **Webhooks** and then **Add webhook**
+* Go to the :guilabel:`Settings` > :guilabel:`Webhooks` > :guilabel:`Add webhook` page for your project
 * For **URL**, use the URL of the integration on Read the Docs,
-  found on the **Dashboard** > **Admin** > **Integrations** page
+  found on the :guilabel:`Admin` > :guilabel:`Integrations`  page
 * Under **Triggers**, **Repository push** should be selected
 * Finish by clicking **Save**
 
@@ -76,10 +77,9 @@ Bitbucket
 GitLab
 ~~~~~~
 
-* Go to the **Settings** page for your project
-* Click **Integrations**
+* Go to the :guilabel:`Settings` > :guilabel:`Integrations` page for your project
 * For **URL**, use the URL of the integration on Read the Docs,
-  found on the **Dashboard** > **Admin** > **Integrations** page
+  found on the :guilabel:`Admin` > :guilabel:`Integrations`  page
 * Leave the default **Push events** selected and mark **Tag push events** also
 * Finish by clicking **Add Webhook**
 
@@ -89,9 +89,9 @@ Using the generic API integration
 ---------------------------------
 
 For repositories that are not hosted with a supported provider, we also offer a
-generic API endpoint for triggering project builds. Similar to webhook
-integrations, this integration has a specific URL, found on the project's
-**Integrations** Admin dashboard page on readthedocs.org.
+generic API endpoint for triggering project builds. Similar to webhook integrations,
+this integration has a specific URL, which can be found on the project's **Integrations** dashboard page
+(:guilabel:`Admin` > :guilabel:`Integrations`).
 
 Token authentication is required to use the generic endpoint, you will find this
 token on the integration details page. The token should be passed in as a
@@ -109,8 +109,8 @@ branches
     Default: **latest**
 
 token
-    The integration token. You'll find this value on the project's
-    **Integrations** Admin dashboard page.
+    The integration token found on the project's **Integrations** dashboard page
+    (:guilabel:`Admin` > :guilabel:`Integrations`).
 
 For example, the cURL command to build the ``dev`` branch, using the token
 ``1234``, would be::