Miscellaneous refinements to GitHub pages

README.rst

@@ -1,4 +1,4 @@
-.. image:: https://www.giotto.ai/static/vector/logo-tda.svg
+.. image:: doc/images/tda_logo.svg
    :width: 850
 
 |Version|_ |Azure-build|_ |Azure-cov|_ |Azure-test|_ |Twitter-follow|_ |Slack-join|_
@@ -25,46 +25,40 @@
 giotto-tda
 ==========
 
-giotto-tda is a high performance topological machine learning toolbox in Python built on top of
-scikit-learn and is distributed under the GNU AGPLv3 license. It is part of the `Giotto <https://github.com/giotto-ai>`_ family of open-source projects.
+``giotto-tda`` is a high-performance topological machine learning toolbox in Python built on top of
+``scikit-learn`` and is distributed under the GNU AGPLv3 license. It is part of the `Giotto <https://github.com/giotto-ai>`_
+family of open-source projects.
 
 Project genesis
 ===============
 
-giotto-tda is the result of a collaborative effort between `L2F SA
-<https://www.l2f.ch/>`_, the `Laboratory for Topology and Neuroscience
-<https://www.epfl.ch/labs/hessbellwald-lab/>`_ at EPFL, and the `Institute of Reconfigurable & Embedded Digital Systems (REDS)
-<https://heig-vd.ch/en/research/reds>`_ of HEIG-VD.
+``giotto-tda`` is the result of a collaborative effort between `L2F SA <https://www.l2f.ch/>`_,
+the `Laboratory for Topology and Neuroscience <https://www.epfl.ch/labs/hessbellwald-lab/>`_ at EPFL,
+and the `Institute of Reconfigurable & Embedded Digital Systems (REDS) <https://heig-vd.ch/en/research/reds>`_ of HEIG-VD.
 
 License
 =======
-
-giotto-tda is distributed under the AGPLv3 `license <https://github.com/giotto-ai/giotto-tda/blob/master/LICENSE>`_. 
-If you need a different distribution license, please contact the L2F team at 
-business@l2f.ch.
+.. _L2F team: business@l2f.ch
+``giotto-tda`` is distributed under the AGPLv3 `license <https://github.com/giotto-ai/giotto-tda/blob/master/LICENSE>`_.
+If you need a different distribution license, please contact the `L2F team`_.
 
 Documentation
 =============
 
-Please visit https://giotto-ai.github.io/gtda-docs and navigate to the version you are interested in.
-
-Getting started
-===============
+Please visit `https://giotto-ai.github.io/gtda-docs <https://giotto-ai.github.io/gtda-docs>`_ and navigate to the version you are interested in.
 
-To get started with giotto-tda, first follow the installations steps below. `This blog post <https://towardsdatascience.com/getting-started-with-giotto-learn-a-python-library-for-topological-machine-learning-451d88d2c4bc>`_, and references therein, offer a friendly introduction to the topic of topological machine learning and to the philosophy behind giotto-tda.
-
-Tutorials and use cases
------------------------
+Use cases
+=========
 
-Simple tutorials can be found in the `examples <https://github.com/giotto-ai/giotto-tda/tree/master/examples>`_ folder. For a wide selection of use cases and application domains, you can visit `this page <https://giotto.ai/learn/course-content>`_.
+For a wide selection of use cases and application domains, you can visit `this page <https://giotto.ai/learn/course-content>`_.
 
 Installation
 ============
 
 Dependencies
 ------------
 
-The latest stable version of giotto-tda requires:
+The latest stable version of ``giotto-tda`` requires:
 
 - Python (>= 3.6)
 - NumPy (>= 1.17.0)
@@ -81,7 +75,7 @@ To run the examples, jupyter is required.
 User installation
 -----------------
 
-The simplest way to install giotto-tda is using ``pip``   ::
+The simplest way to install ``giotto-tda`` is using ``pip``   ::
 
     pip install -U giotto-tda
 
@@ -93,86 +87,27 @@ bug fixes can be installed by running   ::
 
     pip install -U giotto-tda-nightly
 
-The main difference between giotto-tda-nightly and the developer installation (see the section
+The main difference between ``giotto-tda-nightly`` and the developer installation (see the section
 on contributing, below) is that the former is shipped with pre-compiled wheels (similarly to the stable
 release) and hence does not require any C++ dependencies. As the main library module is called ``gtda`` in
-both the stable and nightly versions, giotto-tda and giotto-tda-nightly should not be installed in
+both the stable and nightly versions, ``giotto-tda`` and ``giotto-tda-nightly`` should not be installed in
 the same environment.
 
+Developer installation
+----------------------
+
+Please consult the `relevant page <https://giotto-ai.github.io/gtda-docs/dev/installation.html#developer-installation>`_
+for detailed instructions on how to build ``giotto-tda`` from sources across different platforms.
+
 .. _contributing-section:
 
 Contributing
 ============
 
 We welcome new contributors of all experience levels. The Giotto
 community goals are to be helpful, welcoming, and effective. To learn more about
-making a contribution to giotto-tda, please see the `CONTRIBUTING.rst
-<https://github.com/giotto-ai/giotto-tda/blob/master/CONTRIBUTING.rst>`_ file.
-
-Developer installation
-----------------------
-
-Installing both the PyPI release and source of giotto-tda in the same environment is not recommended since it is
-known to cause conflicts with the C++ bindings.
-
-The developer installation requires three important C++ dependencies:
-
--  A C++14 compatible compiler
--  CMake >= 3.9
--  Boost >= 1.56
-
-Please refer to your system's instructions and to the `CMake <https://cmake.org/>`_ and
-`Boost <https://www.boost.org/doc/libs/1_72_0/more/getting_started/index.html>`_ websites for definitive guidance on how to install these dependencies. The instructions below are unofficial, please follow them at your own risk.
-
-Linux
-~~~~~
-
-Most Linux systems should come with a suitable compiler pre-installed. For the other two dependencies, you may consider using your distribution's package manager, e.g. by running
-
-.. code-block:: bash
-
-    sudo apt-get install cmake libboost-dev
-
-if ``apt-get`` is available in your system.
-
-macOS
-~~~~~
-
-On macOS, you may consider using ``brew`` (https://brew.sh/) to install the dependencies as follows:
-
-.. code-block:: bash
-
-    brew install gcc cmake boost
-
-Windows
-~~~~~~~
-
-On Windows, you will likely need to have `Visual Studio <https://visualstudio.microsoft.com/>`_ installed. At present,
-it appears to be important to have a recent version of the VS C++ compiler. One way to check whether this is the case
-is as follows: 1) open the VS Installer GUI; 2) under the "Installed" tab, click on "Modify" in the relevant VS
-version; 3) in the newly opened window, select "Individual components" and ensure that v14.24 or above of the MSVC
-"C++ x64/x86 build tools" is selected. The CMake and Boost dependencies are best installed using the latest binary
-executables from the websites of the respective projects.
-
-
-Source code
-~~~~~~~~~~~
-
-You can obtain the latest state of the source code with the command::
-
-    git clone https://github.com/giotto-ai/giotto-tda.git
-
-
-To install:
-~~~~~~~~~~~
-
-.. code-block:: bash
-
-   cd giotto-tda
-   python -m pip install -e ".[dev]"
-
-This way, you can pull the library's latest changes and make them immediately available on your machine.
-Note: we recommend upgrading ``pip`` and ``setuptools`` to recent versions before installing in this way.
+making a contribution to ``giotto-tda``, please consult the `relevant page
+<https://giotto-ai.github.io/gtda-docs/dev/contributing/index.html>`_.
 
 Testing
 -------
@@ -182,13 +117,6 @@ source directory::
 
     pytest gtda
 
-
-Changelog
-=========
-
-See the `RELEASE.rst <https://github.com/giotto-ai/giotto-tda/blob/master/RELEASE.rst>`__ file
-for a history of notable changes to giotto-tda.
-
 Important links
 ---------------
 

doc/Makefile

@@ -6,7 +6,7 @@
 ########## Config
 
 ifndef GITDIR
-GITDIR    = ../../../projects/gtda-docs
+GITDIR    = ../../gtda-docs
 endif
 
 ifndef VERSION

doc/conf.py

@@ -23,7 +23,7 @@
 project = 'giotto-tda'
 copyright = '2020, L2F'
 author = 'Guillaume Tauzin, Umberto Lupo, Matteo Caorsi, Anibal Medina, ' \
-         'Lewis Tunstall'
+         'Lewis Tunstall, Wojciech Reise'
 
 # The full version, including alpha/beta/rc tags
 release = __version__
@@ -107,7 +107,6 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-#
 html_theme = "sphinx_rtd_theme"
 
 html_theme_options = {
@@ -122,17 +121,15 @@
 with open('versions', 'r') as f:
     _versions = [c[2:] for c in f.read().splitlines()]
 _versions = list(filter(lambda c: not(c.startswith('.')), _versions))
-html_theme_options.update({'versions': [(c, f'../{c}/index.html')
-                                        for c in set(_versions).union([current_version])]})
+html_theme_options.update({
+    'versions': [
+        (c, f'../{c}/index.html')
+        for c in set(_versions).union([current_version])
+    ]
+})
 
 # Get logo
-path_to_image = "images/tda_logo.svg"
-if not(os.path.exists(path_to_image)):
-    import requests
-    r = requests.get('https://www.giotto.ai/static/vector/logo-tda.svg')
-    with open(path_to_image, 'wb') as f:
-        f.write(r.content)
-html_logo = path_to_image
+html_logo = "images/tda_logo.svg"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -145,4 +142,4 @@
 .. |ProjectVersion| replace:: Foo Project, version {versionnum}
 """.format(
     versionnum=release,
-)
+)