[docs] New docs theme ! (#230)

docs/requirements.txt

@@ -4,10 +4,10 @@ sphinx>=1.8.3, <3.0
 recommonmark  # fails with badges
 nbsphinx
 m2r2
-# m2r  # fails with multi-line text
+asteroid_sphinx_theme
 # pandoc
 # docutils
 # git+https://github.com/mpariente/asteroid_sphinx_theme
 # sphinxcontrib-fulltoc
 # sphinxcontrib-mockautodoc
-# pip_shims
+# pip_shims

docs/source/_templates/theme_variables.jinja

@@ -1,18 +1,18 @@
 {%- set external_urls = {
-  'github': 'https://github.com/PytorchLightning/pytorch-lightning',
-  'github_issues': 'https://github.com/PytorchLightning/pytorch-lightning/issues',
-  'contributing': 'https://github.com/PytorchLightning/pytorch-lightning/blob/master/CONTRIBUTING.md',
-  'governance': 'https://github.com/PytorchLightning/pytorch-lightning/blob/master/governance.md',
-  'docs': 'https://pytorch-lightning.rtfd.io/en/latest',
-  'twitter': 'https://twitter.com/PyTorchLightnin',
+  'github': 'https://github.com/mpariente/asteroid',
+  'github_issues': 'https://github.com/mpariente/asteroid/issues',
+  'contributing': 'https://github.com/mpariente/asteroid/blob/master/CONTRIBUTING.md',
+  'governance': 'https://github.com/mpariente/asteroid/blob/master/CONTRIBUTING.md',
+  'docs': 'https://mpariente.github.io/asteroid/',
+  'twitter': 'https://twitter.com/',
   'discuss': 'https://discuss.pytorch.org',
-  'tutorials': 'https://pytorch-lightning.rtfd.io/en/latest/',
+  'tutorials': '',
   'previous_pytorch_versions': 'https://pytorch-lightning.rtfd.io/en/latest/',
-  'home': 'https://pytorch-lightning.rtfd.io/en/latest/',
-  'get_started': 'https://pytorch-lightning.rtfd.io/en/latest/',
-  'features': 'https://pytorch-lightning.rtfd.io/en/latest/',
-  'blog': 'https://pytorch-lightning.rtfd.io/en/latest/',
-  'resources': 'https://pytorch-lightning.rtfd.io/en/latest/',
-  'support': 'https://pytorch-lightning.rtfd.io/en/latest/',
+  'home': 'https://mpariente.github.io/asteroid/',
+  'get_started': 'https://colab.research.google.com/github/mpariente/asteroid/blob/master/notebooks/01_AsteroidGettingStarted.ipynb',
+  'features': 'https://mpariente.github.io/asteroid/',
+  'blog': 'https://mpariente.github.io/asteroid/',
+  'resources': 'https://mpariente.github.io/asteroid/',
+  'support': 'https://mpariente.github.io/asteroid/',
 }
 -%}

docs/source/conf.py

@@ -14,10 +14,9 @@
 import sys
 import glob
 import shutil
-
 import builtins
+import asteroid_sphinx_theme
 
-# TODO : change it to asteroid_sphinx_theme
 
 PATH_HERE = os.path.abspath(os.path.dirname(__file__))
 PATH_ROOT = os.path.join(PATH_HERE, "..", "..")
@@ -29,9 +28,9 @@
 copyright = "2019, Oncoming"
 author = "Manuel Pariente et al."
 # The short X.Y version
-version = "0.0.1"
+version = "0.4.0"
 # The full version, including alpha/beta/rc tags
-release = "0.0.1"
+release = "0.4.0alpha"
 
 # -- General configuration ---------------------------------------------------
 
@@ -115,15 +114,8 @@
 # html_theme = 'bizstyle'
 # https://sphinx-themes.org
 
-html_theme = "sphinx_rtd_theme"
-
-# import pt_lightning_sphinx_theme
-# html_theme = 'pt_lightning_sphinx_theme'
-# html_theme_path = [pt_lightning_sphinx_theme.get_html_theme_path()]
-
-# import pytorch_sphinx_theme
-# html_theme = 'pytorch_sphinx_theme'
-# html_theme_path = [pytorch_sphinx_theme.get_html_theme_path()]
+html_theme = "asteroid_sphinx_theme"
+html_theme_path = [asteroid_sphinx_theme.get_html_theme_path()]
 #
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -135,6 +127,7 @@
     "collapse_navigation": False,
     "display_version": True,
     "logo_only": False,
+    "asteroid_project": "docs",
 }
 
 html_logo = "_static/images/favicon.ico"