kopia lustrzana https://github.com/wagtail/wagtail
moved pages, images, snippets, form builder, search into reference. Updated requirements, removed conflicting theme css file, updated README
rodzic
16294c2fd2
commit
3e5eb60bf9
|
@ -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.
|
||||
|
|
File diff suppressed because one or more lines are too long
|
@ -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
|
||||
|
|
|
@ -5,6 +5,12 @@ Reference
|
|||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
pages/index
|
||||
images/index
|
||||
search/index
|
||||
snippets
|
||||
form_builder
|
||||
contrib/index
|
||||
management_commands
|
||||
hooks
|
||||
project_template
|
||||
|
|
|
@ -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
|
||||
|
|
Ładowanie…
Reference in New Issue