Skip to content

Commit

Permalink
DOC: Fix tabs in compilation section
Browse files Browse the repository at this point in the history
  • Loading branch information
florian-wagner committed Dec 25, 2023
1 parent 860c95a commit d7370b2
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 60 deletions.
4 changes: 2 additions & 2 deletions INSTALLATION.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Open a terminal (Linux & Mac) or the Anaconda Prompt (Windows) and type:

.. code-block:: bash
conda create -n pg -c gimli -c conda-forge pygimli=1.4.5
conda create -n pg -c gimli -c conda-forge pygimli=1.4.6
If you are using Windows or Mac, a new environment named "pg" should be visible
in the Anaconda Navigator. If you want to use pyGIMLi from the command line, you
Expand Down Expand Up @@ -84,7 +84,7 @@ again and install pygimli using conda just as mentioned above.
import condacolab
condacolab.check()
!conda install -c gimli pygimli=1.4.5
!conda install -c gimli pygimli=1.4.6
Testing the installation
------------------------
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ separate environment. Here we call this environment pg, but you can give it any
name. Note that this environment has to be created only once.

``` bash
conda create -n pg -c gimli -c conda-forge pygimli=1.4.5
conda create -n pg -c gimli -c conda-forge pygimli=1.4.6
```

If you are using Windows or Mac, a new environment named “pg” should be visible in the Anaconda Navigator. If you want to use pygimli from the command line, you have to activate the environment. You can put this line in your ~/.bashrc file so that it is activated automatically if you open a terminal.
Expand Down
1 change: 1 addition & 0 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " api to build API documentation"
@echo " auto to re-build documentation live upon changes using sphinx-autobuild"
@echo " html to make standalone HTML files"
@echo " pdf to make LaTeX files and run them through pdflatex"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
Expand Down
67 changes: 11 additions & 56 deletions doc/compilation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,68 +5,23 @@
Building from source
====================

.. raw:: html
Choose your operating system for more information, in particular on
alternative ways of installation or compilation from source:<br><br>

Choose your operating system for more information, in particular on
alternative ways of installation or compilation from source:<br><br>
<ul class="nav nav-tabs">
<li class="nav-item">
<a class="nav-link active" href="#install_win" role="tab" data-toggle="tab">
<i class="fab fa-windows"></i> Windows</a>
</li>
<li class="nav-item">
<a class="nav-link" href="#install_lin" role="tab" data-toggle="tab">
<i class="fab fa-linux"></i> Linux</a>
</li>
<li class="nav-item">
<a class="nav-link" href="#install_mac" role="tab" data-toggle="tab">
<i class="fab fa-apple"></i> Mac OS</a>
</li>
<li class="nav-item">
<a class="nav-link" href="#install_pre" role="tab" data-toggle="tab">
<i class="fas fa-info"></i> Prerequisites</a>
</li>
</ul>
<div class="tab-content">
.. tab-set::

.. raw:: html
.. tab-item:: Windows

<div role="tabpanel" class="tab-pane active" id="install_win">
.. include:: BUILD_WIN.rst

.. include:: BUILD_WIN.rst
.. tab-item:: Mac

.. raw:: html
.. include:: BUILD_MAC.rst

</div>
</div>
</div>
<div role="tabpanel" class="tab-pane" id="install_lin">
<div>
<div>
.. tab-item:: Linux

.. include:: BUILD_LINUX.rst
.. include:: BUILD_LINUX.rst

.. raw:: html
.. tab-item:: Build dependencies

</div>
</div>
</div>
<div role="tabpanel" class="tab-pane" id="install_mac">
<div>
<div>

.. include:: BUILD_MAC.rst

.. raw:: html

</div>
</div>
<div role="tabpanel" class="tab-pane" id="install_pre">
<div>

.. include:: ../dependencies.rst

.. raw:: html

</div>
</div>
.. include:: ../dependencies.rst
4 changes: 3 additions & 1 deletion doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@

.. include:: ../INSTALLATION.rst

If you want to compile pyGIMLi from source, check out :ref:`sec:build`.
.. note::

If you want to compile pyGIMLi from source, check out :ref:`sec:build`.

0 comments on commit d7370b2

Please sign in to comment.