From 2e0dcc88d58e2043540bba5e4f88d2ebc23a4bf6 Mon Sep 17 00:00:00 2001 From: Karl Hobley Date: Thu, 28 May 2015 12:56:22 +0100 Subject: [PATCH 1/2] Moved some of the reference docs into topics --- docs/index.rst | 9 +++++---- docs/reference/index.rst | 2 -- docs/reference/pages/index.rst | 4 ---- docs/{reference/pages => topics}/creating_pages.rst | 0 .../images/advanced_topics.rst | 0 docs/{reference => topics}/images/index.rst | 0 .../images/using_images_outside_wagtail.rst | 0 .../images/using_in_templates.rst | 0 docs/topics/index.rst | 13 +++++++++++++ docs/{reference => topics}/search/backends.rst | 0 docs/{reference => topics}/search/index.rst | 0 docs/{reference => topics}/search/indexing.rst | 0 docs/{reference => topics}/search/searching.rst | 0 docs/{reference/pages => topics}/streamfield.rst | 0 docs/{reference/pages => topics}/theory.rst | 0 .../pages => topics}/writing_templates.rst | 0 16 files changed, 18 insertions(+), 10 deletions(-) rename docs/{reference/pages => topics}/creating_pages.rst (100%) rename docs/{reference => topics}/images/advanced_topics.rst (100%) rename docs/{reference => topics}/images/index.rst (100%) rename docs/{reference => topics}/images/using_images_outside_wagtail.rst (100%) rename docs/{reference => topics}/images/using_in_templates.rst (100%) create mode 100644 docs/topics/index.rst rename docs/{reference => topics}/search/backends.rst (100%) rename docs/{reference => topics}/search/index.rst (100%) rename docs/{reference => topics}/search/indexing.rst (100%) rename docs/{reference => topics}/search/searching.rst (100%) rename docs/{reference/pages => topics}/streamfield.rst (100%) rename docs/{reference/pages => topics}/theory.rst (100%) rename docs/{reference/pages => topics}/writing_templates.rst (100%) diff --git a/docs/index.rst b/docs/index.rst index 332a01494..f1a753947 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,10 +13,10 @@ Below are some useful links to help you get started with Wagtail. * **Creating your Wagtail site** - * :doc:`reference/pages/creating_pages` - * :doc:`reference/pages/writing_templates` - * :doc:`reference/images/index` - * :doc:`reference/search/index` + * :doc:`topics/creating_pages` + * :doc:`topics/writing_templates` + * :doc:`topics/images/index` + * :doc:`topics/search/index` * :doc:`howto/third_party_tutorials` @@ -34,6 +34,7 @@ Index :titlesonly: getting_started/index + topics/index howto/index reference/index support diff --git a/docs/reference/index.rst b/docs/reference/index.rst index 9da189cdc..cffe5d49b 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -6,8 +6,6 @@ Reference :maxdepth: 2 pages/index - images/index - search/index snippets form_builder contrib/index diff --git a/docs/reference/pages/index.rst b/docs/reference/pages/index.rst index 957840487..16fe35066 100644 --- a/docs/reference/pages/index.rst +++ b/docs/reference/pages/index.rst @@ -11,12 +11,8 @@ The presentation of your content, the actual webpages, includes the normal use o .. toctree:: :maxdepth: 2 - theory - creating_pages - writing_templates model_recipes editing_api - streamfield model_reference queryset_reference advanced_topics/privacy diff --git a/docs/reference/pages/creating_pages.rst b/docs/topics/creating_pages.rst similarity index 100% rename from docs/reference/pages/creating_pages.rst rename to docs/topics/creating_pages.rst diff --git a/docs/reference/images/advanced_topics.rst b/docs/topics/images/advanced_topics.rst similarity index 100% rename from docs/reference/images/advanced_topics.rst rename to docs/topics/images/advanced_topics.rst diff --git a/docs/reference/images/index.rst b/docs/topics/images/index.rst similarity index 100% rename from docs/reference/images/index.rst rename to docs/topics/images/index.rst diff --git a/docs/reference/images/using_images_outside_wagtail.rst b/docs/topics/images/using_images_outside_wagtail.rst similarity index 100% rename from docs/reference/images/using_images_outside_wagtail.rst rename to docs/topics/images/using_images_outside_wagtail.rst diff --git a/docs/reference/images/using_in_templates.rst b/docs/topics/images/using_in_templates.rst similarity index 100% rename from docs/reference/images/using_in_templates.rst rename to docs/topics/images/using_in_templates.rst diff --git a/docs/topics/index.rst b/docs/topics/index.rst new file mode 100644 index 000000000..16c1fea90 --- /dev/null +++ b/docs/topics/index.rst @@ -0,0 +1,13 @@ +====== +Topics +====== + +.. toctree:: + :maxdepth: 2 + + theory + creating_pages + writing_templates + images/index + search/index + streamfield diff --git a/docs/reference/search/backends.rst b/docs/topics/search/backends.rst similarity index 100% rename from docs/reference/search/backends.rst rename to docs/topics/search/backends.rst diff --git a/docs/reference/search/index.rst b/docs/topics/search/index.rst similarity index 100% rename from docs/reference/search/index.rst rename to docs/topics/search/index.rst diff --git a/docs/reference/search/indexing.rst b/docs/topics/search/indexing.rst similarity index 100% rename from docs/reference/search/indexing.rst rename to docs/topics/search/indexing.rst diff --git a/docs/reference/search/searching.rst b/docs/topics/search/searching.rst similarity index 100% rename from docs/reference/search/searching.rst rename to docs/topics/search/searching.rst diff --git a/docs/reference/pages/streamfield.rst b/docs/topics/streamfield.rst similarity index 100% rename from docs/reference/pages/streamfield.rst rename to docs/topics/streamfield.rst diff --git a/docs/reference/pages/theory.rst b/docs/topics/theory.rst similarity index 100% rename from docs/reference/pages/theory.rst rename to docs/topics/theory.rst diff --git a/docs/reference/pages/writing_templates.rst b/docs/topics/writing_templates.rst similarity index 100% rename from docs/reference/pages/writing_templates.rst rename to docs/topics/writing_templates.rst From 1ba7e645fd5c9135c61addc11fe1bde329691204 Mon Sep 17 00:00:00 2001 From: Karl Hobley Date: Thu, 28 May 2015 12:58:50 +0100 Subject: [PATCH 2/2] Renamed howto to advanced topics --- docs/{howto => advanced_topics}/custom_branding.rst | 0 docs/{howto => advanced_topics}/deploying.rst | 2 +- docs/{howto => advanced_topics}/index.rst | 4 ++-- docs/{howto => advanced_topics}/multilingual_sites.rst | 0 docs/{howto => advanced_topics}/performance.rst | 0 docs/{howto => advanced_topics}/settings.rst | 0 docs/{howto => advanced_topics}/third_party_tutorials.rst | 0 docs/getting_started/index.rst | 2 +- docs/index.rst | 4 ++-- 9 files changed, 6 insertions(+), 6 deletions(-) rename docs/{howto => advanced_topics}/custom_branding.rst (100%) rename docs/{howto => advanced_topics}/deploying.rst (85%) rename docs/{howto => advanced_topics}/index.rst (81%) rename docs/{howto => advanced_topics}/multilingual_sites.rst (100%) rename docs/{howto => advanced_topics}/performance.rst (100%) rename docs/{howto => advanced_topics}/settings.rst (100%) rename docs/{howto => advanced_topics}/third_party_tutorials.rst (100%) diff --git a/docs/howto/custom_branding.rst b/docs/advanced_topics/custom_branding.rst similarity index 100% rename from docs/howto/custom_branding.rst rename to docs/advanced_topics/custom_branding.rst diff --git a/docs/howto/deploying.rst b/docs/advanced_topics/deploying.rst similarity index 85% rename from docs/howto/deploying.rst rename to docs/advanced_topics/deploying.rst index 013729b18..9ef240b00 100644 --- a/docs/howto/deploying.rst +++ b/docs/advanced_topics/deploying.rst @@ -4,7 +4,7 @@ Deploying Wagtail On your server ~~~~~~~~~~~~~~ -Wagtail is straightforward to deploy on modern Linux-based distributions, but see the section on :doc:`performance ` for the non-Python services we recommend. If you are running Debian or Ubuntu, this installation script for our Vagrant box may be useful: +Wagtail is straightforward to deploy on modern Linux-based distributions, but see the section on :doc:`performance ` for the non-Python services we recommend. If you are running Debian or Ubuntu, this installation script for our Vagrant box may be useful: `github.com/torchbox/wagtaildemo/blob/master/etc/install/install.sh `_ diff --git a/docs/howto/index.rst b/docs/advanced_topics/index.rst similarity index 81% rename from docs/howto/index.rst rename to docs/advanced_topics/index.rst index 4d630f03f..ac80878d0 100644 --- a/docs/howto/index.rst +++ b/docs/advanced_topics/index.rst @@ -1,5 +1,5 @@ -How to -====== +Advanced topics +=============== .. toctree:: diff --git a/docs/howto/multilingual_sites.rst b/docs/advanced_topics/multilingual_sites.rst similarity index 100% rename from docs/howto/multilingual_sites.rst rename to docs/advanced_topics/multilingual_sites.rst diff --git a/docs/howto/performance.rst b/docs/advanced_topics/performance.rst similarity index 100% rename from docs/howto/performance.rst rename to docs/advanced_topics/performance.rst diff --git a/docs/howto/settings.rst b/docs/advanced_topics/settings.rst similarity index 100% rename from docs/howto/settings.rst rename to docs/advanced_topics/settings.rst diff --git a/docs/howto/third_party_tutorials.rst b/docs/advanced_topics/third_party_tutorials.rst similarity index 100% rename from docs/howto/third_party_tutorials.rst rename to docs/advanced_topics/third_party_tutorials.rst diff --git a/docs/getting_started/index.rst b/docs/getting_started/index.rst index 9c6b6a5e1..c1342513a 100644 --- a/docs/getting_started/index.rst +++ b/docs/getting_started/index.rst @@ -36,7 +36,7 @@ Your site is now accessible at ``http://localhost:8000``, with the admin backend There are a few optional packages which are not installed by default but are recommended to improve performance or add features to Wagtail, including: - * :doc:`Elasticsearch `. + * :doc:`Elasticsearch `. * :ref:`image_feature_detection`. diff --git a/docs/index.rst b/docs/index.rst index f1a753947..c632a15c7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -17,7 +17,7 @@ Below are some useful links to help you get started with Wagtail. * :doc:`topics/writing_templates` * :doc:`topics/images/index` * :doc:`topics/search/index` - * :doc:`howto/third_party_tutorials` + * :doc:`advanced_topics/third_party_tutorials` * **Using Wagtail** @@ -35,7 +35,7 @@ Index getting_started/index topics/index - howto/index + advanced_topics/index reference/index support editor_manual/index