Skip to content

Commit

Permalink
Fixed issues with formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
vcalderon2009 committed Feb 5, 2018
1 parent c083404 commit 1b0059b
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 15 deletions.
10 changes: 5 additions & 5 deletions docs/source/mac_101.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ can use to edit and run your scripts.

After having downloaded and installed Xcode, there are a few commands that
need to be run in order to let other programs run, i.e.
**`Xcode Command-line Tools <https://railsapps.github.io/xcode-command-line-tools.html>`_**.
`Xcode Command-line Tools <https://railsapps.github.io/xcode-command-line-tools.html>`_.

You should run the following commands from the Terminal:

Expand Down Expand Up @@ -74,16 +74,16 @@ LaTeX
Another important package that you need to install whenever you get a new
MAC is **LaTeX**. LaTeX is a *document preparation system* that lets you
present your work or documents in a presentable format. LaTeX is
also used a lot by scientific journals, i.e. **Astrophysical Journal**,
**`Monthly Notices of the Royal Astronomical Society <https://academic.oup.com/mnras>`_**.
also used a lot by scientific journals, i.e. `Astrophysical Journal <http://iopscience.iop.org/journal/0004-637X>`_,
`Monthly Notices of the Royal Astronomical Society <https://academic.oup.com/mnras>`_.

To download LaTeX on a MAC, you need to download **MacTEX**.
This can be found at `https://www.tug.org/mactex/ <https://www.tug.org/mactex/>`_.

After downloading the necessary :code:`.pkg` file, you will be able to
execute and run LaTeX on your computer.

For a tutorial on how to use LaTeX, go to the links in LaTeX_links_.
For a tutorial on how to use LaTeX, go to the links in :ref:`LaTeX_links`.

.. _VPN:
^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -202,7 +202,7 @@ Now you can access a remote computer by logging in from the terminal:
The tedious thing about this is that it will prompt you for
your password anytime that you want to access the remote server.

This can be solved by using **:code:`SSH keys`**.
This can be solved by using :code:`SSH keys`.

.. _SSH_Keys:
^^^^^^^^^^^^^
Expand Down
23 changes: 13 additions & 10 deletions docs/source/python_intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ From their website:
deliver actionable insights that drive businesses and industries forward.


Having **Ananconda* installed on your computer is important, since it
Having **Anaconda** installed on your computer is important, since it
allows you to not worry about installing missing dependencies,
creates environments for you projects, etc.

Expand Down Expand Up @@ -71,7 +71,7 @@ terminal:
.. note:: If you're using a separate machine, to which you `ssh`, you can
install *Anaconda* to a specified location other than your home directory.
This is important if you are limited by *the number of files in your
home directory**, e.g. a computer hosted by
**home directory**, e.g. a computer hosted by
`ACCRE <http://www.accre.vanderbilt.edu/>`_.

.. _Anaconda_Environments:
Expand All @@ -91,7 +91,7 @@ your own defined environment for your project, and you can

All of the packages can be specified in an **environment.yml** file.
An example for such file would look like
(taken from `<conda.io/docs/user-guide/tasks/manage-environments.html>`_):
(taken from `Conda Manage Environments <conda.io/docs/user-guide/tasks/manage-environments.html>`_):

.. code::
Expand Down Expand Up @@ -121,11 +121,12 @@ running the command on the terminal:

>>> conda env create -f environment.yml

For more information, see `<https://conda.io/docs/user-guide/tasks/manage-environments.html#creating-an-environment-from-an-environment-yml-file>`_.
For more information, see
`Creating an environment from an environment.yml file <https://conda.io/docs/user-guide/tasks/manage-environments.html#creating-an-environment-from-an-environment-yml-file>`_.

.. note::
A helpful package to use is
**`conda-env-auto <https://github.com/chdoig/conda-auto-env>`_** which allows
`conda-env-auto <https://github.com/chdoig/conda-auto-env>`_ which allows
you to automatically create and *activate* the project environment once you
are in the directory. For more information on how to install it and
use it, see `<https://github.com/chdoig/conda-auto-env>`_.
Expand All @@ -150,10 +151,12 @@ Cookiecutter and Folder Structure

I would suggest starting with the
`Cookiecutter Data Science <https://drivendata.github.io/cookiecutter-data-science/>`_
project structure, a
project structure,

*A logical, reasonably standardized, but flexible project structure for
doing and sharing data science work*
::

**A logical, reasonably standardized, but flexible project structure for
doing and sharing data science work**

This folder structure allows everyone looking at your code to
understand it right away.
Expand Down Expand Up @@ -207,7 +210,7 @@ The structure of the project looks like:
└── tox.ini <- tox file with settings for running tox; see tox.testrun.org
It includes *Makefiles*, documentation, dependencies files, etc., to
It includes a **Makefile**, documentation, dependencies files, etc., to
make it easy to structure your code.

To start a **new project**:
Expand All @@ -222,7 +225,7 @@ To start a **new project**:
advice using it, since it allows for better structure and
reproducibility.

For **my version* of the cookiecutter Data Science **template**, you can
For **my version** of the cookiecutter Data Science **template**, you can
clone `<https://github.com/vcalderon2009/cookiecutter-data-science/>`_
and use that folder structure *instead*.

Expand Down

0 comments on commit 1b0059b

Please sign in to comment.