replacing index.html hard-code with an rST page

NandniJamnadas · Jun 15, 2020 · 5764aaf · 5764aaf
1 parent d4bc92c
commit 5764aaf
Show file tree

Hide file tree

Showing 11 changed files with 243 additions and 228 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -12,8 +12,7 @@ jobs:
             - cache-pip
       - run: pip install --user -e .
       - run: pip install --user -r docs/doc-requirements.txt
-      - run: pip install --user sphinx_rtd_theme
-
+
       # Cache some files for a speedup in subsequent builds
       - save_cache:
           key: cache-pip
@@ -25,7 +24,7 @@ jobs:
           command: |
             cd docs
             make html
-      
+
       # Tell Circle to store the documentation output in a folder that we can access later
       - store_artifacts:
           path: docs/build/html/
@@ -36,4 +35,4 @@ workflows:
   version: 2
   default:
     jobs:
-      - docs
+      - docs
diff --git a/.travis.yml b/.travis.yml
@@ -8,7 +8,7 @@ jobs:
     - stage: test-docs
       install:
       - pip install --upgrade pip sphinx
-      - pip install pydata_sphinx_theme recommonmark sphinx-intl
+      - pip install -r docs/doc-requirements.txt
       script:
       # Test build of HTML docs and English translation templates
       - make -C docs html
@@ -17,7 +17,7 @@ jobs:
     - stage: push-tx
       install:
       - pip install --upgrade pip sphinx
-      - pip install pydata_sphinx_theme recommonmark sphinx-intl
+      - pip install -r docs/doc-requirements.txt
       script:
       - cd docs
       # Rebuild HTML again to test for merge problems

diff --git a/docs/doc-requirements.txt b/docs/doc-requirements.txt
@@ -3,3 +3,4 @@ sphinx-intl
 recommonmark==0.4.0
 nbsphinx
 pydata-sphinx-theme
+sphinx-panels
diff --git a/docs/source/_static/custom.css b/docs/source/_static/custom.css
@@ -20,3 +20,28 @@ p.first.admonition-title {
 	color: #ffffff;
 }
 
+
+/* Front page table styling */
+
+.front-page-table td > p {
+    margin-bottom: 0em;
+}
+
+.front-page-table td > p:last-child {
+    font-style: italic;
+}
+
+.front-page-table a.reference {
+    font-size: 1.3em;
+}
+
+.front-page-table.table td, .front-page-table.table th {
+    border: none;
+    padding-top: .3em;
+    padding-bottom: .3em;
+}
+
+div.card ul.simple {
+    list-style: none;
+    padding-left: 1em;
+}
diff --git a/docs/source/_templates/index.html b/docs/source/_templates/index.html
diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html
diff --git a/docs/source/_templates/navbar.html b/docs/source/_templates/navbar.html
diff --git a/docs/source/_templates/sidebartoc.html b/docs/source/_templates/sidebartoc.html
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -29,9 +29,12 @@
     'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
     'sphinx.ext.graphviz', # Add the graphviz extension
-    'recommonmark'
+    'recommonmark',
+    'sphinx_panels'
 ]
 
+panels_add_boostrap_css = False
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -43,7 +46,7 @@
 #source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'contents'
+master_doc = 'index'
 
 # General information about the project.
 project = 'Jupyter Documentation'
@@ -92,7 +95,7 @@
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-html_additional_pages = {'index': 'index.html'}
+html_additional_pages = {}
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'Jupyter'
@@ -168,4 +171,8 @@
 # -- Translation ----------------------------------------------------------
 
 gettext_uuid = True
-locale_dirs = ['locale/']
+locale_dirs = ['locale/']
+
+
+def setup(app):
+    app.add_css_file("custom.css")
diff --git a/docs/source/contents.rst b/docs/source/contents.rst