moved pages, images, snippets, form builder, search into reference. Updated requirements, removed conflicting theme css file, updated README

pull/1303/head
Dave Cranwell 2015-05-14 11:18:53 +01:00
rodzic 16294c2fd2
commit 3e5eb60bf9
34 zmienionych plików z 22 dodań i 22 usunięć

Wyświetl plik

@ -1,16 +1,17 @@
# Wagtail docs # 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 requirements-dev.txt
pip install sphinx-rtd-theme
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. The online editor at http://rst.ninjs.org/ is a helpful tool for checking reStructuredText syntax.

File diff suppressed because one or more lines are too long

Wyświetl plik

@ -13,10 +13,10 @@ Below are some useful links to help you get started with Wagtail.
* **Creating your Wagtail site** * **Creating your Wagtail site**
* :doc:`pages/creating_pages` * :doc:`reference/pages/creating_pages`
* :doc:`pages/writing_templates` * :doc:`reference/pages/writing_templates`
* :doc:`images/index` * :doc:`reference/images/index`
* :doc:`search/index` * :doc:`reference/search/index`
* :doc:`howto/third_party_tutorials` * :doc:`howto/third_party_tutorials`
@ -33,12 +33,6 @@ Index
:titlesonly: :titlesonly:
getting_started/index getting_started/index
pages/index
images/index
snippets
search/index
form_builder
contrib/index
howto/index howto/index
reference/index reference/index
support support

Wyświetl plik

@ -5,6 +5,12 @@ Reference
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
pages/index
images/index
search/index
snippets
form_builder
contrib/index
management_commands management_commands
hooks hooks
project_template project_template

Wyświetl plik

@ -8,6 +8,9 @@ Pillow>=2.7.0
coverage>=3.7.0 coverage>=3.7.0
flake8>=2.2.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 sphinxcontrib-spelling==2.1.1
pyenchant==1.6.6 pyenchant==1.6.6