Standardize documentation sites

Author: jsiegle

LICENSE

@@ -5,6 +5,6 @@ verify_ssl = true
 
 [packages]
 sphinx = "*"
-pydata-sphinx-theme = "0.3.1"
+pydata-sphinx-theme = "0.13.3"
 sphinx-tabs = "*"
 make = "*"

Pipfile

@@ -1,19 +1,18 @@
 =========
-Template for Open Ephys Documentation
+Documentation for the Open Ephys GUI
 =========
 
 This documentation's source template was taken from the `Spinal HDL <https://github.com/SpinalHDL/SpinalDoc-RTD>`_ project.
 
 The theme is based on the `PyData Sphinx Theme <https://pydata-sphinx-theme.readthedocs.io/en/latest/>`_
 
+For more detailed usage instructions, see the `Open Ephys Doc Template <https://github.com/open-ephys/doc-template>`_
+
 How to build this documentation
 ===============================
 
 With pipenv (recommended)
 -----------
-Requirements (system)
-
-* make
 
 Requirements (Python 3):
 
@@ -58,8 +57,7 @@ Requirements (system):
 Requirements (Python 3):
 
 * sphinx
-* sphinx-rtd-theme
-* sphinxcontrib-wavedrom
+* pydata-sphinx-theme=="0.13.3"
 
 After installing the requirements you can run
 
@@ -70,13 +68,3 @@ After installing the requirements you can run
    make latexpdf # for latex (will require latexpdf installed)
    make          # list all the available output format
 
-Continuous Integration(CI)
-==========================
-
-This repo uses Travis for its CI needs.
-If you want have a gh-pages preview on your fork, you need to activate your repo on Travis admin page.
-After that you only need add ``GITHUB_TOKEN`` as Environment Variable with your Github personal token (you only need grant repo/public_repo access)
-More details here:
-
-* `Defining variables <https://docs.travis-ci.com/user/environment-variables/#defining-variables-in-repository-settings>`_
-* `Deploy to gh-pages <https://docs.travis-ci.com/user/deployment/pages/>`_

Pipfile.lock

@@ -58,12 +58,81 @@
   margin-right: 10px;
 }
 
+.search-button {
+  color: white !important;
+  margin-right: 30px;
+}
+
+
 .navbar a:hover {
   color: #f9f2d5 !important;
   transition-duration: 0.4s;
 }
 
-/* left side links */
+
+/* Landing page cards */
+.card-columns {
+  column-count: 4 !important;
+}
+
+.card-title {
+  margin: 1rem;
+}
+
+.intro-card .card-text {
+  margin:20px 0px;
+  color: var(--onix-txt-color) !important;
+}
+
+.card-img-top {
+  margin-top: 2em;
+}
+
+.card {
+  border: 0;
+}
+
+.intro-card {
+  transition: transform 0.2s ease;
+  border: 0;
+}
+
+.intro-card:hover {
+  transform: scale(1.05);
+}
+
+.col-lg-6 {
+  margin-top: 2em;
+}
+
+/* Gallery cards */
+
+.gallery-card .card-header {
+  height: 100%;
+  margin-top: 0rem;
+  align-items: center;
+  justify-content: center;
+  text-align: center;
+} /* example of the default height for title */
+
+.bd-content {
+  flex-grow: 1;
+  max-width: 100%;
+}
+
+.bd-page-width {
+  max-width: 100rem;
+}
+
+.bd-sidebar-primary {
+ width: 20%;
+}
+
+strong {
+ font-weight: bold;
+}
+
+/* left side links 
 .bd-links>.active a {
   color: #3c81be !important;
   transition-duration: 0.4s;
@@ -73,35 +142,35 @@
   color: #5fb5dc !important;
   transition-duration: 0.4s;
   transform: translate(2px, 0px);
-}
+}*/
 
-/* right side links */
+/* right side links 
 .toc-entry>.nav-link.active {
   font-weight: 600;
   color: #344b39;
   background-color: transparent;
   border-left: 2px solid #da714a;
-}
+}*/
 
-/* body links (external) */
+/* body links (external) 
 a.reference.external {
   color: #9a5035;
 }
 
 a.reference.external:hover {
   color: #da714a;
   text-decoration: none;
-}
+}*/
 
-/* body links (internal) */
+/* body links (internal) 
 a.reference.internal {
   color: #3c81be;
 }
 
 a.reference.internal:hover {
   color: #5fb5dc;
   text-decoration: none;
-}
+}*/
 
 /* header links */
 a.headerlink {
@@ -279,7 +348,7 @@ h6 {
 /* logo */
 .navbar-brand {
   position: relative;
-  height: 50px;
+  height: 70px;
   width: auto;
 }
 

README.rst

@@ -40,7 +40,8 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx.ext.todo", "sphinx.ext.githubpages"]
+extensions = ["sphinx.ext.todo", 
+              "sphinx.ext.githubpages"]
 
 
 # Add any paths that contain templates here, relative to this directory.
@@ -59,7 +60,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -77,15 +78,22 @@
 # a list of builtin themes.
 #
 html_theme = "pydata_sphinx_theme"
-html_logo = "_static/images/oe_logo_gui.svg"
+html_logo = "_static/images/oe_logo_name.svg"
 html_scaled_image_link = True
 html_title = project
+html_show_sourcelink = True
 
 # 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,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
 
+html_sidebars = {
+    'index': ['search-field.html'],
+    "**": ["sidebar-nav-bs.html"]
+}
+
+
 html_css_files = ['theme_overrides.css']
 
 #html_style = "_static/theme_overrides.css"
@@ -177,11 +185,22 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
-    "github_url": "https://github.com/open-ephys",
+    'use_edit_page_button': True,
     "navigation_with_keys": True,
     "navbar_end": ["navbar-icon-links"],
-    "navbar_align": "content"
-    # 'search_bar_position' : "navbar",
+    "navbar_align": "content",
+    "footer_start": ["copyright"],
+    'icon_links': [
+        dict(name='GitHub',
+             url='https://github.com/open-ephys/commutator-docs',
+             icon='fab fa-github'),
+        dict(name='Twitter',
+             url='https://twitter.com/openephys',
+             icon='fab fa-twitter'),
+        dict(name='Discord',
+             url='https://discord.gg/WXAx2URNQU',
+             icon='fab fa-discord')
+    ],
     #'canonical_url': '',
     #'analytics_id': '',
     #'logo_only': False,
@@ -202,15 +221,12 @@
 
 html_context = {
     "github_user": "open-ephys",
-    "github_repo": "doc-template",
-    "github_version": "master",
+    "github_repo": "gui-docs",
+    "github_version": "main",
     "doc_path": "source",
     "default_mode": "light"
 }
 
-
-html_show_sourcelink = False
-
 linkcheck_anchors = False
 
 extensions.append("sphinx_tabs.tabs")