Skip to content

Commit

Permalink
Added some startpp documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
schwanksta committed Jan 23, 2015
1 parent 55d0e05 commit b8623df
Show file tree
Hide file tree
Showing 6 changed files with 70 additions and 16 deletions.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
Binary file not shown.
30 changes: 25 additions & 5 deletions docs/_build/html/_sources/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -201,11 +201,11 @@ we'll use to put together our website.

$ pip install Django

Now use Django's ``django-admin.py`` command to create a new "project" that will be organized according to the framework's rules.
Now use Django's ``django-admin`` command to create a new "project" that will be organized according to the framework's rules.

.. code-block:: bash

$ django-admin.py startproject project
$ django-admin startproject project

Now jump into the project and we'll start setting it up.

Expand All @@ -215,10 +215,30 @@ Now jump into the project and we'll start setting it up.

.. note::

Wonder what all those weird files are in your new directory? We'll only need a couple for this tutorial, but you can read about all of them in the `official Django documentation <https://docs.djangoproject.com/en/1.7/intro/tutorial01/#creating-a-project>`_.
Run the ``ls`` command, which lists the files in your current location. Wonder what all those weird files are in your new directory? We'll only need a couple for this tutorial, but you can read about all of them in the `official Django documentation <https://docs.djangoproject.com/en/1.7/intro/tutorial01/#creating-a-project>`_.

- Configure the settings (How much do we explain?)

Go back one directory before you create your app, which should exist alongside the project folder.

.. code-block:: bash

$ cd ..

Now let's create the app. In Django terms, an "app" is a group of code files that describe the information in your database and how it functions in the Django admin. Optionally, it describes how you output the information into web pages or APIs.

Your app will have simple models to encapsulate the data in the Academy CSV, as well as fields we are interested in filling later for data collection

.. code-block:: bash

$ django-admin startapp academy

The startapp command just created a barebones Django app for you. Jump in and let's see what files are there.

.. code-block:: bash

$ cd academy

- Configure the settings
- Create an app
- Fire up the runserver for the first time to look at default admin

Act 2: Hello models
Expand Down
24 changes: 19 additions & 5 deletions docs/_build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -198,8 +198,8 @@ <h3>Python<a class="headerlink" href="#python" title="Permalink to this headline
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>pip install Django
</pre></div>
</div>
<p>Now use Django&#8217;s <tt class="docutils literal"><span class="pre">django-admin.py</span></tt> command to create a new &#8220;project&#8221; that will be organized according to the framework&#8217;s rules.</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>django-admin.py startproject project
<p>Now use Django&#8217;s <tt class="docutils literal"><span class="pre">django-admin</span></tt> command to create a new &#8220;project&#8221; that will be organized according to the framework&#8217;s rules.</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>django-admin startproject project
</pre></div>
</div>
<p>Now jump into the project and we&#8217;ll start setting it up.</p>
Expand All @@ -208,11 +208,25 @@ <h3>Python<a class="headerlink" href="#python" title="Permalink to this headline
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Wonder what all those weird files are in your new directory? We&#8217;ll only need a couple for this tutorial, but you can read about all of them in the <a class="reference external" href="https://docs.djangoproject.com/en/1.7/intro/tutorial01/#creating-a-project">official Django documentation</a>.</p>
<p class="last">Run the <tt class="docutils literal"><span class="pre">ls</span></tt> command, which lists the files in your current location. Wonder what all those weird files are in your new directory? We&#8217;ll only need a couple for this tutorial, but you can read about all of them in the <a class="reference external" href="https://docs.djangoproject.com/en/1.7/intro/tutorial01/#creating-a-project">official Django documentation</a>.</p>
</div>
<ul class="simple">
<li>Configure the settings (How much do we explain?)</li>
</ul>
<p>Go back one directory before you create your app, which should exist alongside the project folder.</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span><span class="nb">cd</span> ..
</pre></div>
</div>
<p>Now let&#8217;s create the app. In Django terms, an &#8220;app&#8221; is a group of code files that describe the information in your database and how it functions in the Django admin. Optionally, it describes how you output the information into web pages or APIs.</p>
<p>Your app will have simple models to encapsulate the data in the Academy CSV, as well as fields we are interested in filling later for data collection</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>django-admin startapp academy
</pre></div>
</div>
<p>The startapp command just created a barebones Django app for you. Jump in and let&#8217;s see what files are there.</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span><span class="nb">cd </span>academy
</pre></div>
</div>
<ul class="simple">
<li>Configure the settings</li>
<li>Create an app</li>
<li>Fire up the runserver for the first time to look at default admin</li>
</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

30 changes: 25 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -201,11 +201,11 @@ we'll use to put together our website.
$ pip install Django
Now use Django's ``django-admin.py`` command to create a new "project" that will be organized according to the framework's rules.
Now use Django's ``django-admin`` command to create a new "project" that will be organized according to the framework's rules.

.. code-block:: bash
$ django-admin.py startproject project
$ django-admin startproject project
Now jump into the project and we'll start setting it up.

Expand All @@ -215,10 +215,30 @@ Now jump into the project and we'll start setting it up.
.. note::

Wonder what all those weird files are in your new directory? We'll only need a couple for this tutorial, but you can read about all of them in the `official Django documentation <https://docs.djangoproject.com/en/1.7/intro/tutorial01/#creating-a-project>`_.
Run the ``ls`` command, which lists the files in your current location. Wonder what all those weird files are in your new directory? We'll only need a couple for this tutorial, but you can read about all of them in the `official Django documentation <https://docs.djangoproject.com/en/1.7/intro/tutorial01/#creating-a-project>`_.

- Configure the settings (How much do we explain?)

Go back one directory before you create your app, which should exist alongside the project folder.

.. code-block:: bash
$ cd ..
Now let's create the app. In Django terms, an "app" is a group of code files that describe the information in your database and how it functions in the Django admin. Optionally, it describes how you output the information into web pages or APIs.

Your app will have simple models to encapsulate the data in the Academy CSV, as well as fields we are interested in filling later for data collection

.. code-block:: bash
$ django-admin startapp academy
The startapp command just created a barebones Django app for you. Jump in and let's see what files are there.

.. code-block:: bash
$ cd academy
- Configure the settings
- Create an app
- Fire up the runserver for the first time to look at default admin

Act 2: Hello models
Expand Down

0 comments on commit b8623df

Please sign in to comment.