diff --git a/docs/getting_started/index.rst b/docs/getting_started/index.rst index 2b19b66f2..fd3bd284c 100644 --- a/docs/getting_started/index.rst +++ b/docs/getting_started/index.rst @@ -2,7 +2,10 @@ Getting started =============== .. note:: - These instructions assume familiarity with virtual environments and the `Django web framework `_. For more detailed instructions, see :doc:`tutorial`. To add Wagtail to an existing Django project, see :doc:`integrating_into_django`. + These instructions assume familiarity with virtual environments and the + `Django web framework `_. + For more detailed instructions, see :doc:`tutorial`. + To add Wagtail to an existing Django project, see :doc:`integrating_into_django`. Dependencies needed for installation @@ -30,7 +33,9 @@ Once installed, Wagtail provides a command similar to Django's ``django-admin st $ wagtail start mysite -This will create a new folder ``mysite``, based on a template containing all you need to get started. More information on that template is available in :doc:`the project template reference `. +This will create a new folder ``mysite``, based on a template containing all you need to get started. +More information on that template is available in +:doc:`the project template reference `. Inside your ``mysite`` folder, run the setup steps necessary for any Django project: @@ -43,7 +48,8 @@ Inside your ``mysite`` folder, run the setup steps necessary for any Django proj Your site is now accessible at ``http://localhost:8000``, with the admin backend available at ``http://localhost:8000/admin/``. -This will set you up with a new stand-alone Wagtail project. If you'd like to add Wagtail to an existing Django project instead, see :doc:`integrating_into_django`. +This will set you up with a new stand-alone Wagtail project. +If you'd like to add Wagtail to an existing Django project instead, see :doc:`integrating_into_django`. There are a few optional packages which are not installed by default but are recommended to improve performance or add features to Wagtail, including: diff --git a/docs/getting_started/tutorial.rst b/docs/getting_started/tutorial.rst index f45952ef6..e5e96803f 100644 --- a/docs/getting_started/tutorial.rst +++ b/docs/getting_started/tutorial.rst @@ -2,7 +2,8 @@ Your first Wagtail site ======================= .. note:: - This tutorial covers setting up a brand new Wagtail project. If you'd like to add Wagtail to an existing Django project instead, see :doc:`integrating_into_django`. + This tutorial covers setting up a brand new Wagtail project. + If you'd like to add Wagtail to an existing Django project instead, see :doc:`integrating_into_django`. Install and run Wagtail ----------------------- @@ -22,13 +23,15 @@ If this does not return a version number or returns a version before 3.4, you wi .. important:: Before installing Wagtail, it is necessary to install the **libjpeg** and **zlib** libraries, which provide support for working with JPEG, PNG and GIF images (via the Python **Pillow** library). - The way to do this varies by platform—see Pillow's `platform-specific installation instructions `_. + The way to do this varies by platform—see Pillow's + `platform-specific installation instructions `_. Create and activate a virtual environment ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -We recommend using a virtual environment, which provides an isolated Python environment. This tutorial uses `venv `_, which is packaged with Python 3. +We recommend using a virtual environment, which provides an isolated Python environment. +This tutorial uses `venv `_, which is packaged with Python 3. Create a virtual environment: @@ -70,12 +73,12 @@ Generate your site $ wagtail start mysite $ cd mysite -Wagtail provides a ``start`` command similar to -``django-admin.py startproject``. Running ``wagtail start mysite`` in -your project will generate a new ``mysite`` folder with a few -Wagtail-specific extras, including the required project settings, a -"home" app with a blank ``HomePage`` model and basic templates and a sample -"search" app. +Wagtail provides a ``start`` command similar to ``django-admin.py startproject``. +Running ``wagtail start mysite`` in your project will generate a new ``mysite`` folder with a few Wagtail-specific extras, including +the required project settings, +a "home" app with a blank ``HomePage`` model +and basic templates +and a sample "search" app. Install project dependencies ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -84,13 +87,14 @@ Install project dependencies $ pip install -r requirements.txt -This ensures that you have the relevant version of Django and any other dependencies for the project you have just created. +This ensures that you have the relevant version of +Django +and any other dependencies for the project you have just created. Create the database ~~~~~~~~~~~~~~~~~~~ -If you haven't updated the project settings, this will be a SQLite -database file in the project directory. +If you haven't updated the project settings, this will be a SQLite database file in the project directory. .. code-block:: console