Skip to content

Commit

Permalink
small docs fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
ianhi committed Aug 31, 2020
1 parent 4458af1 commit 67a4923
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ help:
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

watch:
sphinx-autobuild source build/html -B
sphinx-autobuild source build/html --open-browser
5 changes: 3 additions & 2 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Contributing
============

Thanks for thinking of a way to help improve this library! Remember that contributions come in all
shapes and sizes beyond writing bug fixes. Contributing to documentation, opening new `issues <https://github.com/quantstack/ipycytoscape/issues>`_ for bugs, asking for clarification
shapes and sizes beyond writing bug fixes: Contributing to documentation, opening new `issues <https://github.com/quantstack/ipycytoscape/issues>`_ for bugs, asking for clarification
on things you find unclear, and requesting new features, are all super valuable contributions.

Code Improvements
Expand Down Expand Up @@ -33,7 +33,8 @@ Using Git/Github can confusing (https://xkcd.com/1597/) so if you're new to Git,
it helpful to use a program like `Github Desktop <desktop.github.com>`_ and to follow
a `guide <https://github.com/firstcontributions/first-contributions#first-contributions>`_.

Also feel free to ask for help/advice on the relevant Github `issue <https://github.com/quantstack/ipycytoscape/issues>`_.
Also feel free to ask for help/advice on the relevant Github `issue <https://github.com/quantstack/ipycytoscape/issues>`_
or in the `Gitter chat <https://gitter.im/QuantStack/Lobby>`_.

Documentation
-------------
Expand Down
6 changes: 4 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@ To get started with ipycytoscape, install with pip::

pip install ipycytoscape

or with conda::
or with conda/`mamba <https://github.com/TheSnakePit/mamba>`_::

conda install ipycytoscape
conda install -c conda-forge ipycytoscape
# or with mamba
mamba install -c conda-forge ipycytoscape


Simple Example
Expand Down
8 changes: 5 additions & 3 deletions docs/source/installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@ Installation
============


The simplest way to install ipycytoscape is via pip::
To get started with ipycytoscape, install with pip::

pip install ipycytoscape

or via conda::
or with conda/`mamba <https://github.com/TheSnakePit/mamba>`_::

conda install ipycytoscape
conda install -c conda-forge ipycytoscape
# or with mamba
mamba install -c conda-forge ipycytoscape


JupyterLab
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@
'docs': [
'sphinx',
'sphinx_rtd_theme',
'sphinx-autobuild',
'sphinx-autobuild>=2020.9.1',
'jupyter-sphinx>=0.3.1',
'sphinx-copybutton',
'nbsphinx',
Expand Down

0 comments on commit 67a4923

Please sign in to comment.