From d7370b2d703c664522810dbfc97beeb589bd23b7 Mon Sep 17 00:00:00 2001 From: Florian Wagner Date: Mon, 25 Dec 2023 11:58:03 +0100 Subject: [PATCH] DOC: Fix tabs in compilation section --- INSTALLATION.rst | 4 +-- README.md | 2 +- doc/Makefile | 1 + doc/compilation.rst | 67 ++++++++------------------------------------ doc/installation.rst | 4 ++- 5 files changed, 18 insertions(+), 60 deletions(-) diff --git a/INSTALLATION.rst b/INSTALLATION.rst index d267a1351..51e5801f3 100644 --- a/INSTALLATION.rst +++ b/INSTALLATION.rst @@ -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 @@ -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 ------------------------ diff --git a/README.md b/README.md index 3c488b791..9998af692 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/doc/Makefile b/doc/Makefile index 5e77343d4..a5a297a29 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -21,6 +21,7 @@ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . help: @echo "Please use \`make ' where 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)" diff --git a/doc/compilation.rst b/doc/compilation.rst index c46a64534..785c88458 100644 --- a/doc/compilation.rst +++ b/doc/compilation.rst @@ -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:

- Choose your operating system for more information, in particular on - alternative ways of installation or compilation from source:

- -
+.. tab-set:: -.. raw:: html + .. tab-item:: Windows -
+ .. include:: BUILD_WIN.rst -.. include:: BUILD_WIN.rst + .. tab-item:: Mac -.. raw:: html + .. include:: BUILD_MAC.rst -
-
- -
-
-
+ .. tab-item:: Linux -.. include:: BUILD_LINUX.rst + .. include:: BUILD_LINUX.rst -.. raw:: html + .. tab-item:: Build dependencies -
-
-
-
-
-
- -.. include:: BUILD_MAC.rst - -.. raw:: html - -
-
-
-
- -.. include:: ../dependencies.rst - -.. raw:: html - -
-
+ .. include:: ../dependencies.rst \ No newline at end of file diff --git a/doc/installation.rst b/doc/installation.rst index e20615127..3a0db8f6f 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -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`.