travis fixes

tapaswenipathak · tapaswenipathak · commit 5c385f068c04 · 2019-10-16T18:27:15.000+05:30
diff --git a/docs/_static/images/guides/how-to/github-build-status-reporting.gif b/docs/_static/images/guides/how-to/github-build-status-reporting.gif
diff --git a/docs/_static/images/guides/how-to/google-search-engine-results.png b/docs/_static/images/guides/how-to/google-search-engine-results.png
diff --git a/docs/builds.rst b/docs/builds.rst
@@ -61,7 +61,7 @@ Read the Docs cannot create a PDF version of your documentation with the *Mkdocs
 
 .. warning::
 
-   We strongly recommend to :ref:`pin the MkDocs version <guides/specifying-dependencies:Specifying Dependencies>`
+   We strongly recommend to :ref:`pin the MkDocs version <guides/troubleshooting/specifying-dependencies:Specifying Dependencies>`
    used for your project to build the docs to avoid potential future incompatibilities.
 
 
@@ -109,7 +109,7 @@ An example in code:
     Regardless of whether you build your docs with Sphinx or MkDocs,
     we recommend you pin the version of Sphinx or Mkdocs you want us to use.
     You can do this the same way other
-    :doc:`dependencies are specified <guides/specifying-dependencies>`.
+    :doc:`dependencies are specified <guides/troubleshooting/specifying-dependencies>`.
     Some examples of pinning versions might be ``sphinx<2.0`` or ``mkdocs>=1.0``.
 
 Builder responsibility
diff --git a/docs/faq.rst b/docs/faq.rst
@@ -75,7 +75,7 @@ My project requires different settings than those available under Admin
 Read the Docs offers some settings which can be used for a variety of purposes,
 such as to use the latest version of sphinx or pip. To enable these settings,
 please send an email to support@readthedocs.org and we will change the settings for the project.
-Read more about these settings :doc:`here <guides/feature-flags>`.
+Read more about these settings :doc:`here <guides/troubleshooting/feature-flags>`.
 
 I get import errors on libraries that depend on C modules
 ---------------------------------------------------------
@@ -194,7 +194,7 @@ and as a result, it tends to look a bit better with the default theme.
 .. note::
 
    To use these extensions you need to specify the dependencies on your project
-   by following this :doc:`guide <guides/specifying-dependencies>`.
+   by following this :doc:`guide <guides/troubleshooting/specifying-dependencies>`.
 
 Can I document a python package that is not at the root of my repository?
 -------------------------------------------------------------------------
diff --git a/docs/features.rst b/docs/features.rst
@@ -8,7 +8,7 @@ GitHub, Bitbucket and GitLab Integration
 
 We now support linking by default in the sidebar. It links to the page on your host, which should help people quickly update typos and send pull requests to contribute to project documentation.
 
-More information can be found in :doc:`guides/vcs`.
+More information can be found in :doc:`guides/troubleshooting/vcs`.
 
 Auto-updating
 -------------
@@ -26,7 +26,7 @@ Canonical URLs
 
 Canonical URLs give your docs better search performance, by pointing all URLs to one version. This also helps to solve the issues around users landing on outdated versions of documentation.
 
-More information can be found in the :doc:`guides/canonical` page.
+More information can be found in the :doc:`guides/troubleshooting/canonical` page.
 
 Versions
 --------
diff --git a/docs/guides/how-to/autobuild-docs-for-pull-requests.rst b/docs/guides/how-to/autobuild-docs-for-pull-requests.rst
@@ -2,7 +2,7 @@ Autobuild Documentation for Pull Requests
 =========================================
 
 Read the Docs allows autobuilding documentation for pull/merge requests for GitHub or GitLab projects.
-This feature is currently available under a :doc:`Feature Flag </guides/feature-flags>`.
+This feature is currently available under a :doc:`Feature Flag </guides/troubleshooting/feature-flags>`.
 So, you can enable this feature by sending us an `email <mailto:support@readthedocs.org>`__ including your project URL.
 
 Features
diff --git a/docs/guides/how-to/google-analytics.rst b/docs/guides/how-to/google-analytics.rst
diff --git a/docs/guides/how-to/index.rst b/docs/guides/how-to/index.rst
@@ -16,10 +16,11 @@ whether that is Sphinx or MkDocs.
     :maxdepth: 1
 
     adding-custom-css
-    custom-404-page
     manage-translations
     remove-edit-buttons
-    vcs
+    build-notifications
+    build-using-too-many-resources
+    technical-docs-seo-guide
 
 Read the Docs how-to guides
 ---------------------------
@@ -32,10 +33,4 @@ These guides will help you customize or tune aspects of the Read the Docs build
     autobuild-docs-for-pull-requests
     build-notifications
     technical-docs-seo-guide
-    canonical
-    conda
-    environment-variables
-    feature-flags
     google-analytics
-    searching-with-readthedocs
-    sitemaps
diff --git a/docs/guides/how-to/technical-docs-seo-guide.rst b/docs/guides/how-to/technical-docs-seo-guide.rst
@@ -141,7 +141,7 @@ Redirects
 ~~~~~~~~~
 
 Redirects tell search engines when content has moved.
-For example, if this guide moved from ``guides/technical-docs-seo-guide.html`` to ``guides/sphinx-seo-guide.html``,
+For example, if this guide moved from ``guides/how-to/technical-docs-seo-guide.html`` to ``guides/sphinx-seo-guide.html``,
 there will be a time period where search engines will still have the old URL in their index
 and will still be showing it to users.
 This is why it is important to update your own links within your docs as well as redirecting.
@@ -161,7 +161,7 @@ The canonical URL tells search engines where the original version
 your documentation is even if you have multiple versions on the internet
 (for example, incomplete translations or deprecated versions).
 
-Read the Docs supports :doc:`setting the canonical URL </guides/canonical>`
+Read the Docs supports :doc:`setting the canonical URL </guides/troubleshooting/canonical>`
 if you are using a :doc:`custom domain </custom_domains>`
 under :guilabel:`Admin` > :guilabel:`Domains`
 in the Read the Docs dashboard.
@@ -197,7 +197,7 @@ or any alternate language versions of a page.
 
 Read the Docs generates a sitemap for you that contains the last time
 your documentation was updated as well as links to active versions, subprojects, and translations your project has.
-We have a small separate guide on :doc:`sitemaps </guides/how-to/sitemaps>`.
+We have a small separate guide on :doc:`sitemaps </guides/troubleshooting/sitemaps>`.
 
 See the `Google docs on building a sitemap <https://support.google.com/webmasters/answer/183668>`_.
 
diff --git a/docs/guides/troubleshooting/conda.rst b/docs/guides/troubleshooting/conda.rst
@@ -11,7 +11,7 @@ This work was funded by `Clinical Graphics`_ -- many thanks for their support of
 Activating Conda
 ----------------
 
-Conda support is available using a :doc:`../config-file/index`, see :ref:`config-file/v2:conda`.
+Conda support is available using a :doc:`../../config-file/index`, see :ref:`config-file/v2:conda`.
 
 This Conda environment will also have Sphinx and other build time dependencies installed.
 It will use the same order of operations that we support currently:
diff --git a/docs/guides/troubleshooting/index.rst b/docs/guides/troubleshooting/index.rst
@@ -15,10 +15,13 @@ whether that is Sphinx or MkDocs.
 .. toctree::
     :maxdepth: 1
 
+    custom-404-page
     mkdocs-old-versions
     pdf-non-ascii-languages
-    remove-edit-buttons
-
+    vcs
+    feature-flags
+    sitemaps
+    wipe-environment
 
 Read the Docs troubleshooting guides
 -------------------------------------
@@ -32,3 +35,4 @@ These troubleshooting guides are for the Read the Docs build environment.
     conda
     environment-variables
     specifying-dependencies
+    searching-with-readthedocs
diff --git a/docs/guides/troubleshooting/searching-with-readthedocs.rst b/docs/guides/troubleshooting/searching-with-readthedocs.rst
@@ -7,7 +7,7 @@ how to use advanced query syntax to get more accurate results and
 many other search features that Read the Docs supports with example searches.
 
 You can find information on the search architecture and how we index document on our
-:doc:`Search <../development/search>` docs.
+:doc:`Search <../../development/search>` docs.
 
 
 .. contents:: Table of contents
@@ -67,7 +67,7 @@ You can see these analytics in your project admin dashboard.
 .. note::
 
     Currently, this feature is in beta state and is available under a
-    :ref:`feature flag <guides/feature-flags:Available Flags>`.
+    :ref:`feature flag <guides/troubleshooting/feature-flags:Available Flags>`.
     We plan to make this available for everyone soon.
     If you want to test this feature out and help giving us feedback,
     please contact us via `GitHub issues`_.
@@ -102,7 +102,7 @@ Search inside subprojects
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
 We allow projects to configured as subprojects of another project.
-You can read more about this in our :doc:`Subprojects <../subprojects>` documentation.
+You can read more about this in our :doc:`Subprojects <../../subprojects>` documentation.
 
 If a search is made in a project which have one or more subprojects under it,
 the search results then also includes the results from subprojects because
diff --git a/docs/index.rst b/docs/index.rst
@@ -122,7 +122,8 @@ out of your documentation and Read the Docs.
   :doc:`Automatic redirects <automatic-redirects>`
 
 * **Topic specific guides**:
-  :doc:`How-to guides <guides/index>`
+  :doc:`How-to guides <guides/how-to/index>`
+  :doc:`Troubleshooting guides <guides/troubleshooting/index>`
 
 * **Extending Read the Docs**:
   :doc:`REST API <api/index>`
@@ -142,7 +143,8 @@ out of your documentation and Read the Docs.
    user-defined-redirects
    automatic-redirects
 
-   guides/index
+   guides/how-to/index
+   guides/troubleshooting/index
 
    api/index
 
diff --git a/docs/single_version.rst b/docs/single_version.rst
@@ -23,6 +23,6 @@ if pip was set as a "Single Version" project, then links to its documentation wo
 ``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:`guides/canonical` should stop these from being indexed by Google.
+However, our usage of :doc:`guides/troubleshooting/canonical` should stop these from being indexed by Google.
 
 .. _dashboard: https://readthedocs.org/dashboard/
