diff --git a/docs/dev_guide/getting_started/quickstart.rst b/docs/dev_guide/getting_started/quickstart.rst index b18911039..4e51364e6 100644 --- a/docs/dev_guide/getting_started/quickstart.rst +++ b/docs/dev_guide/getting_started/quickstart.rst @@ -2,30 +2,31 @@ Mojito Quickstart ================= -.. _mojito_qs-prereqs: +.. _mojito_quickstart-reqs: -Prerequisites -============= +Requirements +============ **System:** Unix-based system. -**Software:** `Node.js (>= 0.6.0 < 0.9.0) `_, `npm (> 1.0.0) `_ +**Software:** `Node.js (>= 0.8.0) `_, `npm (> 1.0.0) `_ -.. _mojito_qs-install: +.. _mojito_quickstart-install: Installation Steps ================== -#. Get Mojito from the npm registry and globally install Mojito so that it can be run from - the command line. You may need to use ``sudo`` if you run into permission errors. +#. Globally install the Mojito CLI package (``mojito-cli``) from the npm registry + so that you can run Mojito commands. You may need to use ``sudo`` if + you run into permission errors. - ``$ npm install mojito -g`` + ``$ npm install mojito-cli -g`` #. Confirm that Mojito has been installed by running the help command. ``$ mojito help`` -.. _mojito_qs-create: +.. _mojito_quickstart-create_app: Create a Mojito Application =========================== @@ -34,7 +35,7 @@ Create a Mojito Application #. ``$ cd hello_world`` #. ``$ mojito create mojit myMojit`` -.. _mojito_qs-modify: +.. _mojito_quickstart-modify_app: Modify Your Application ======================= @@ -55,7 +56,7 @@ To make the application return a string we want, replace the code in }; }); -.. _mojito_qs-running: +.. _mojito_quickstart-run_app: Running the Application ======================= @@ -63,11 +64,9 @@ Running the Application #. From the ``hello_world`` application directory, start Mojito: ``$ mojito start`` - #. Go to http://localhost:8666/@myMojit/index to see your application. - #. Stop your application by pressing **Ctrl-C**. -For a more in-depth tutorial, please see `Mojito: Getting Started <../getting_started/>`_. To learn more about Mojito, see -the `Mojito Documentation <../>`_. +For a more in-depth tutorial, please see `Tutorial: Creating Your First Application `_. +To learn more about Mojito, see the `Mojito Documentation <../>`_. diff --git a/docs/dev_guide/quickstart/conf.py b/docs/dev_guide/quickstart/conf.py deleted file mode 100644 index bf67e9344..000000000 --- a/docs/dev_guide/quickstart/conf.py +++ /dev/null @@ -1,220 +0,0 @@ - -# -# Cocktails documentation build configuration file, created by -# sphinx-quickstart on Wed Oct 12 18:07:15 2011. -# -# This file is execfile()d with the current directory set to its containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys, os - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ----------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.doctest', 'sphinx.ext.ifconfig'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['/home/y/share/htdocs/cocktails/sphinx_rst_ydn/ydn_template/without_toc/'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -# project = u'Cocktails' -copyright = u'2011, Yahoo! Inc., 2011' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -#version = '0.1.0.178' -# The full version, including alpha/beta/rc tags. -#release = '0.1.0.178' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ['.build'] - -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -highlight_language = 'javascript' -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - - -# -- Options for HTML output --------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'ydntheme' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -html_theme_path = ['/home/y/share/htdocs/cocktails/sphinx_rst_ydn/ydn_template/'] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -html_title = 'Mojito Quickstart' - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# html_logo = 'images/molotov-cocktail_logo.png' - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# html_favicon = 'images/Mojito.ico' - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -#html_static_path = ['.static'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = { -# '**':["other_links.html"] -# } - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -html_show_sourcelink = False - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'MojitoQuickstart' - - -# -- Options for LaTeX output -------------------------------------------------- - -# The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' - -# The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'Cocktails.tex', u'Cocktails Documentation', - u'Joe Catera', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Additional stuff for the LaTeX preamble. -#latex_preamble = '' - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output -------------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'Mojito', u'Mojito Intro', - [u'Joe Catera'], 1) -] - diff --git a/docs/dev_guide/quickstart/index.rst b/docs/dev_guide/quickstart/index.rst deleted file mode 100644 index 5849beff3..000000000 --- a/docs/dev_guide/quickstart/index.rst +++ /dev/null @@ -1,72 +0,0 @@ -================= -Mojito Quickstart -================= - -.. _mojito_quickstart-reqs: - -Requirements -============ - -**System:** Unix-based system. - -**Software:** `Node.js (>= 0.8.0) `_, `npm (> 1.0.0) `_ - -.. _mojito_quickstart-install: - -Installation Steps -================== - -#. Globally install the Mojito CLI package (``mojito-cli``) from the npm registry - so that you can run Mojito commands. You may need to use ``sudo`` if - you run into permission errors. - - ``$ npm install mojito-cli -g`` - -#. Confirm that Mojito has been installed by running the help command. - - ``$ mojito help`` - -.. _mojito_quickstart-create_app: - -Create a Mojito Application -=========================== - -#. ``$ mojito create app hello_world`` -#. ``$ cd hello_world`` -#. ``$ mojito create mojit myMojit`` - -.. _mojito_quickstart-modify_app: - -Modify Your Application -======================= - -To make the application return a string we want, replace the code in -``mojits/myMojit/controller.server.js`` with the following: - -.. code-block:: javascript - - YUI.add('myMojit', function(Y, NAME) { - - Y.namespace('mojito.controllers')[NAME] = { - - index: function(ac) { - ac.done('Hello, world. I have created my first Mojito app at ' + (new Date()) + '.'); - } - - }; - }); - -.. _mojito_quickstart-run_app: - -Running the Application -======================= - -#. From the ``hello_world`` application directory, start Mojito: - - ``$ mojito start`` -#. Go to http://localhost:8666/@myMojit/index to see your application. -#. Stop your application by pressing **Ctrl-C**. - -For a more in-depth tutorial, please see `Mojito: Getting Started <../getting_started/>`_. -To learn more about Mojito, see the `Mojito Documentation <../>`_. -