Skip to content

Commit

Permalink
Docs formatting cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
vidartf committed Nov 2, 2018
1 parent abdde8f commit d44e3b5
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 15 deletions.
4 changes: 2 additions & 2 deletions docs/source/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Configuration

Nbdime uses a config system loosely based on that of Jupyter. This means that
it looks for config files ``nbdime_config.json`` in all the directories listed
by the ``jupyter --paths`` command, as well as the current working directory.
by the :command:`jupyter --paths` command, as well as the current working directory.
The syntax of the config files are similar to that of other Jupyter commands::

{
Expand Down Expand Up @@ -208,7 +208,7 @@ GitMerge
These sections are ways to configure several commands / entrypoints
at once. The individual command names are the once listed in
parantheses at the end of the sections, or can be seen by running
``nbdime --config``.
:command:`nbdime --config`.



Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ The quickest way to get set up for git integration is to call::

.. versionadded:: 0.3

``nbdime config-git``. Prior to 0.3, each nbdime entrypoint had to enable git integration separately.
:command:`nbdime config-git`. Prior to 0.3, each nbdime entrypoint had to enable git integration separately.

This will enable the both the drivers and the tools for both diff and merge.

Expand Down
12 changes: 6 additions & 6 deletions docs/source/installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,11 @@ Installing a development version of nbdime requires

Installing nbdime using :command:`pip` will install the Python package
dependencies and
will automatically run ``npm`` to install the required Node.js packages.
will automatically run :command:`npm` to install the required Node.js packages.

To install Node.js, either follow the instructions on its webpage or install it
from conda (``conda install nodejs``). Alternatively, if you use ``venv`` to
manage your environment, you can install ``nodeenv`` to have node managed by
from conda (:command:`conda install nodejs`). Alternatively, if you use :command:`venv` to
manage your environment, you can install :command:`nodeenv` to have node managed by
venv. See :doc:`this page <nodevenv>` for details.


Expand All @@ -76,7 +76,7 @@ Download and install directly from source::
pip install -e git+https://github.com/jupyter/nbdime#egg=nbdime

Or clone the `nbdime repository <https://github.com/jupyter/nbdime>`_
and use ``pip`` to install::
and use :command:`pip` to install::

git clone https://github.com/jupyter/nbdime
cd nbdime
Expand All @@ -98,14 +98,14 @@ you will also have to run the following commands after the pip dev install::
jupyter labextension install ./packages/labextension


If you do any changes to the front-end code, run ``npm run build`` from the
If you do any changes to the front-end code, run :command:`npm run build` from the
repoistory root to rebuild the extensions. If you make any changes to the
server extension, you will have to restart the server to pick up the changes!


.. note::

The optional ``--sym-link`` flag for ``jupyter nbextension install`` allows
The optional ``--sym-link`` flag for :command:`jupyter nbextension install` allows
the notebook frontend to pick up a newly built version of the extension on
a page refresh. For details on the other flags, see
:doc:`extensions`.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/nodevenv.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Setting up a virtualenv with Node.js

The following steps will: create a virtualenv, named ``myenv``, in the current
directory; activate the virtualenv; and install npm inside the virtualenv
using ``nodeenv``::
using :command:`nodeenv`::

python3 -m venv myenv # For Python 2: python2 -m virtualenv myenv
source myenv/bin/activate
Expand Down
10 changes: 5 additions & 5 deletions docs/source/vcs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ the ``--global`` or ``--system`` options.

.. versionadded:: 0.3

``nbdime config-git``. Prior to 0.3, each nbdime entrypoint had to enable git integration separately.
:command:`nbdime config-git`. Prior to 0.3, each nbdime entrypoint had to enable git integration separately.

.. note::
When neither the global or system flag is given, the configuration
Expand Down Expand Up @@ -108,11 +108,11 @@ and::
.. note::

If you simply call :command:`git mergetool --tool nbdime`, it will be
alled for all merge conflicts, even on filetypes that it cannot
called for all merge conflicts, even on filetypes that it cannot
handle. To only call on notebooks, add a filter on file paths, e.g.
:command:`git mergetool --tool nbdime -- *.ipynb`.
**This command has also been aliased as :command:`nbdime mergetool`
for easy access**, and you can also add your own git alias for this
*This command has also been aliased as* :command:`nbdime mergetool`
*for easy access*, and you can also add your own git alias for this
command.


Expand Down Expand Up @@ -287,7 +287,7 @@ Differs
*******

To tell mercurial about nbdimes differs, open the appropriate
config file (``hg config --edit`` for the default user level one),
config file (:command:`hg config --edit` for the default user level one),
and add the following entries::

[extensions]
Expand Down

0 comments on commit d44e3b5

Please sign in to comment.