readthedocs.org/docs/single_version.rst

Single Version Documentation
----------------------------

Single Version Documentation lets you serve your docs at a root domain.
By default, all documentation served by Read the Docs has a root of ``/<language>/<version>/``.
But, if you enable the "Single Version" option for a project, its documentation will instead be served at ``/``.

.. warning:: This means you can't have translations or multiple versions for your documentation.

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.

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.org/`` rather than the default ``http://pip.readthedocs.org/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.

.. _dashboard: https://readthedocs.org/dashboard/
Add unindexed single_versions doc. Refs #293 2014-01-03 21:18:18 +00:00			`Single Version Documentation`
			`----------------------------`

			`Single Version Documentation lets you serve your docs at a root domain.`
Edits to Single Version Documentation. Most changes are stylistic. The only substantive change is in the "Enabling" section, which talked about setting the canonical URL option, not the Single Version option. 2014-01-04 19:47:50 +00:00			By default, all documentation served by Read the Docs has a root of ``/<language>/<version>/``.
			But, if you enable the "Single Version" option for a project, its documentation will instead be served at ``/``.
Add unindexed single_versions doc. Refs #293 2014-01-03 21:18:18 +00:00
			`.. warning:: This means you can't have translations or multiple versions for your documentation.`

Fix wording 2014-01-06 17:58:07 +00:00			`You can see a live example of this at http://www.contribution-guide.org`
Add contribution guide as an example 2014-01-06 17:55:35 +00:00
Add unindexed single_versions doc. Refs #293 2014-01-03 21:18:18 +00:00			`Enabling`
Rejigger indexing 2014-01-18 14:10:25 +00:00			`~~~~~~~~`
Add unindexed single_versions doc. Refs #293 2014-01-03 21:18:18 +00:00
Edits to Single Version Documentation. Most changes are stylistic. The only substantive change is in the "Enabling" section, which talked about setting the canonical URL option, not the Single Version option. 2014-01-04 19:47:50 +00:00			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.
Add unindexed single_versions doc. Refs #293 2014-01-03 21:18:18 +00:00
			`Effects`
Rejigger indexing 2014-01-18 14:10:25 +00:00			`~~~~~~~`
Add unindexed single_versions doc. Refs #293 2014-01-03 21:18:18 +00:00
Edits to Single Version Documentation. Most changes are stylistic. The only substantive change is in the "Enabling" section, which talked about setting the canonical URL option, not the Single Version option. 2014-01-04 19:47:50 +00:00			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.org/`` rather than the default ``http://pip.readthedocs.org/en/latest/``.
Add unindexed single_versions doc. Refs #293 2014-01-03 21:18:18 +00:00
Fix typos 2015-06-11 07:23:16 +00:00			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.
Add unindexed single_versions doc. Refs #293 2014-01-03 21:18:18 +00:00
			`.. _dashboard: https://readthedocs.org/dashboard/`