Merge remote-tracking branch 'davecranwell/docs-reorganisation'

2026-04-22 07:34:45 +00:00 · 2015-05-14 12:14:58 +01:00 · 2015-05-14 12:14:58 +01:00 · 543cedec40
commit 543cedec40
parent 13e8c5b04b 5c16f9e7e0
35 changed files with 23 additions and 23 deletions
--- a/docs/README.md
+++ b/docs/README.md
@ -1,16 +1,17 @@
 # Wagtail docs

-These are Sphinx docs, automatically built at http://docs.wagtail.io when the master branch is committed to Github. To build them locally, install Sphinx and the RTD theme:
+These are Sphinx docs, automatically built at http://docs.wagtail.io when the master branch is committed to Github. To build them locally, install Wagatail's development requirements (in the root Wagtail directory):

-    pip install Sphinx
-    pip install sphinx-rtd-theme
+    pip install requirements-dev.txt

-Then ``make html`` from this directory, and open ``_build/html/index.html`` in your browser.
+To build the documentation for browsing, from this directory run: 

-We've provided a watchdog script (based on @jacobian's [snippet](http://jacobian.org/writing/auto-building-sphinx/)) to auto-build your local docs when you save them. Install watchdog:
+    ``make html`` 

-    pip install watchdog
+then open ``_build/html/index.html`` in a browser.

-Then run ``./autobuild.sh`` before you start editing.
+To rebuild automatically while editing the documentation, from this directory run:
+
+    ``sphinx-autobuild . _build``

 The online editor at http://rst.ninjs.org/ is a helpful tool for checking reStructuredText syntax.
--- a/docs/_static/css/theme.css
+++ b/docs/_static/css/theme.css
--- 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:`pages/creating_pages`
-  * :doc:`pages/writing_templates`
-  * :doc:`images/index`
-  * :doc:`search/index`
+  * :doc:`reference/pages/creating_pages`
+  * :doc:`reference/pages/writing_templates`
+  * :doc:`reference/images/index`
+  * :doc:`reference/search/index`
  * :doc:`howto/third_party_tutorials`


@ -33,12 +33,6 @@ Index
   :titlesonly:

   getting_started/index
-   pages/index
-   images/index
-   snippets
-   search/index
-   form_builder
-   contrib/index
   howto/index
   reference/index
   support
--- a/docs/reference/contrib/api/configuration.rst
+++ b/docs/reference/contrib/api/configuration.rst
--- a/docs/reference/contrib/api/index.rst
+++ b/docs/reference/contrib/api/index.rst
--- a/docs/reference/contrib/api/installation.rst
+++ b/docs/reference/contrib/api/installation.rst
--- a/docs/reference/contrib/api/usage.rst
+++ b/docs/reference/contrib/api/usage.rst
--- a/docs/reference/contrib/frontendcache.rst
+++ b/docs/reference/contrib/frontendcache.rst
--- a/docs/reference/contrib/index.rst
+++ b/docs/reference/contrib/index.rst
--- a/docs/reference/contrib/routablepage.rst
+++ b/docs/reference/contrib/routablepage.rst
--- a/docs/reference/contrib/sitemaps.rst
+++ b/docs/reference/contrib/sitemaps.rst
--- a/docs/reference/contrib/staticsitegen.rst
+++ b/docs/reference/contrib/staticsitegen.rst
--- a/docs/reference/form_builder.rst
+++ b/docs/reference/form_builder.rst
--- a/docs/reference/images/advanced_topics.rst
+++ b/docs/reference/images/advanced_topics.rst
--- a/docs/reference/images/index.rst
+++ b/docs/reference/images/index.rst
--- a/docs/reference/images/using_images_outside_wagtail.rst
+++ b/docs/reference/images/using_images_outside_wagtail.rst
--- a/docs/reference/images/using_in_templates.rst
+++ b/docs/reference/images/using_in_templates.rst
--- a/docs/reference/index.rst
+++ b/docs/reference/index.rst
@ -5,7 +5,12 @@ Reference
 .. toctree::
    :maxdepth: 2

+    pages/index
+    images/index
+    search/index
+    snippets
+    form_builder
+    contrib/index
    management_commands
    hooks
    project_template
-    page
--- a/docs/reference/pages/advanced_topics/private_pages.rst
+++ b/docs/reference/pages/advanced_topics/private_pages.rst
--- a/docs/reference/pages/advanced_topics/queryset_methods.rst
+++ b/docs/reference/pages/advanced_topics/queryset_methods.rst
--- a/docs/reference/pages/attributes_properties_methods.rst
+++ b/docs/reference/pages/attributes_properties_methods.rst
--- a/docs/reference/pages/creating_pages.rst
+++ b/docs/reference/pages/creating_pages.rst
--- a/docs/reference/pages/editing_api.rst
+++ b/docs/reference/pages/editing_api.rst
--- a/docs/reference/pages/index.rst
+++ b/docs/reference/pages/index.rst
@ -20,3 +20,4 @@ The presentation of your content, the actual webpages, includes the normal use o
    sites
    advanced_topics/queryset_methods
    advanced_topics/private_pages
+    attributes_properties_methods
--- a/docs/reference/pages/model_recipes.rst
+++ b/docs/reference/pages/model_recipes.rst
--- a/docs/reference/pages/sites.rst
+++ b/docs/reference/pages/sites.rst
--- a/docs/reference/pages/streamfield.rst
+++ b/docs/reference/pages/streamfield.rst
--- a/docs/reference/pages/theory.rst
+++ b/docs/reference/pages/theory.rst
--- a/docs/reference/pages/writing_templates.rst
+++ b/docs/reference/pages/writing_templates.rst
--- a/docs/reference/search/backends.rst
+++ b/docs/reference/search/backends.rst
--- a/docs/reference/search/index.rst
+++ b/docs/reference/search/index.rst
--- a/docs/reference/search/indexing.rst
+++ b/docs/reference/search/indexing.rst
--- a/docs/reference/search/searching.rst
+++ b/docs/reference/search/searching.rst
--- a/docs/reference/snippets.rst
+++ b/docs/reference/snippets.rst
--- a/requirements-dev.txt
+++ b/requirements-dev.txt
@ -8,6 +8,9 @@ Pillow>=2.7.0
 coverage>=3.7.0
 flake8>=2.2.0

-# For spellchecking the documentation
+# For documentation
+Sphinx>=1.3.1
+sphinx-autobuild>=0.5.2
+sphinx_rtd_theme>=0.1.8
 sphinxcontrib-spelling==2.1.1
 pyenchant==1.6.6