Skip to content

Commit

Permalink
Merged in fix/consolidate_docs-bdice (pull request #66)
Browse files Browse the repository at this point in the history
Minor changes for consistency across packages.

* Minor changes for consistency across packages.

* Update conda URL.
  • Loading branch information
bdice authored and csadorf committed Oct 27, 2018
1 parent 82bef52 commit ba14a1b
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 22 deletions.
13 changes: 4 additions & 9 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
.. signac documentation master file, created by
sphinx-quickstart on Fri Oct 23 17:41:32 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Signac (core) package documentation
===================================

Expand All @@ -11,16 +6,16 @@ Signac (core) package documentation
This is documentation for the **signac** *core package*, which is part of the signac_ framework.
See `here <signac-docs_>`_ for a comprehensive introduction to the **signac** *framework*.

.. _signac: https://glotzerlab.engin.umich.edu/signac/
.. _signac-docs: https://signac.readthedocs.io/en/latest
.. _signac: http://www.signac.io/
.. _signac-docs: https://docs.signac.io/

Contents
--------

.. toctree::
:hidden:

Go to Framework Documentation <https://docs.signac.io/en/latest/>
Go to Framework Documentation <https://docs.signac.io/>

.. toctree::
:maxdepth: 2
Expand All @@ -32,7 +27,7 @@ Contents


Indices and tables
==================
------------------

* :ref:`genindex`
* :ref:`modindex`
Expand Down
17 changes: 5 additions & 12 deletions doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,18 @@ The recommended installation method for **signac** is via conda_ or pip_.
The software is tested for Python versions 2.7.x and 3.4+ and does not have any *hard* dependencies, i.e. there are no packages or libraries required to use the core **signac** functions.
However, some extra features, such as the database integration require additional packages.

.. _conda: https://anaconda.org/
.. _pip: https://docs.python.org/3.5/installing/index.html
.. _conda: https://conda.io/
.. _conda-forge: https://conda-forge.org/
.. _pip: https://pip.pypa.io/en/stable/

Install with conda
==================

To install **signac** via conda, you first need to add the conda-forge_ channel with:

.. _conda-forge: https://conda-forge.github.io

.. code:: bash
$ conda config --add channels conda-forge
Once the **conda-forge** channel has been enabled, **signac** can be installed with:
You can install **signac** via conda (available on the conda-forge_ channel), with:

.. code:: bash
$ conda install signac
$ conda install -c conda-forge signac
All additional dependencies will be installed automatically.
To upgrade the package, execute:
Expand Down
2 changes: 1 addition & 1 deletion doc/support.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Support and Development
-----------------------

To get help using the signac package, either send an email to `signac-support@umich.edu <mailto:signac-support@umich.edu>`_ or join the `signac gitter chatroom <https://gitter.im/signac/Lobby>`_.
To get help using the **signac** package, either send an email to `signac-support@umich.edu <mailto:signac-support@umich.edu>`_ or join the `signac gitter chatroom <https://gitter.im/signac/Lobby>`_.

The **signac** package is hosted on `Bitbucket <https://bitbucket.org/glotzer/signac>`_ and licensed under the open-source BSD 3-Clause license.
Please use the `repository's issue tracker <https://bitbucket.org/glotzer/signac/issues?status=new&status=open>`_ to report bugs or request new features.
Expand Down

0 comments on commit ba14a1b

Please sign in to comment.