Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix images in installation instructions. #502

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix images in installation instructions. #502

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,15 @@ git clone https://github.com/<your-github-username>/xeus-cling.git

You may also want to install a C++ compiler, and cmake from conda if they are not available on your system.

### Contributing to the documentation

You don't need to build and install the package to build the documentation.
[Sphinx](https://www.sphinx-doc.org) is used to generate it and should be installed in your
development environment or system.

The documentation sources are in `docs/sources/` and uses [ReStructured Text](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html).
When done with your modifications you can render them with
```bash
cd docs
make html
```
10 changes: 10 additions & 0 deletions docs/source/_static/main_stylesheet.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,13 @@
max-width: 1000px;
margin: auto;
}

.rst-content h2 > img {
width: 30px;
margin-bottom: 0;
margin-top: 0;
margin-right: 15px;
margin-left: 15px;
float: left;
}

28 changes: 8 additions & 20 deletions docs/source/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,25 @@

The full license is in the file LICENSE, distributed with this software.

.. raw:: html

<style>
.rst-content .section>img {
width: 30px;
margin-bottom: 0;
margin-top: 0;
margin-right: 15px;
margin-left: 15px;
float: left;
}
</style>
.. |conda| image:: conda.svg

.. |cmake| image:: cmake.svg


Installation
============

.. image:: conda.svg

Using the conda-forge package
------------------------------
|conda| Using the conda-forge package
-------------------------------------

A package for xeus-cling is available for the mamba (or conda) package manager.

.. code::

mamba install -c conda-forge xeus-cling

.. image:: cmake.svg

From source with cmake
----------------------
|cmake| From source with cmake
------------------------------

You can also install ``xeus-cling`` from source with cmake. This requires that you have all the dependencies installed in the same prefix.

Expand Down