Initial Commit

Minimalistic Example of Hosting Sphnix on Neltify.

Author: seowings

Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = ./source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

README.md

@@ -1,2 +1,21 @@
-# sphinx-netlify
-Minimalistic Example of Sphinx on Netlify
+# sphinx-netliy : Minimalistic Example of Sphinx on Netlify
+
+[![Netlify Status](https://api.netlify.com/api/v1/badges/6e617b73-9bc1-453a-b318-564653a46048/deploy-status)](https://app.netlify.com/sites/sphinx-netlify/deploys)
+
+This repo is a minimalistic working example of delploying Static Sites Generated using Sphinx. It has been tested with
+
+1. Python v. 3.8
+2. sphinx v. 4.3.1
+3. sphinx_rtd_theme v. 1.0.0
+
+## Install
+
+Just clone this repository and then delpying it from Netlify. Nothing need to be changed and it will work out of the box.
+
+## Tweaking
+
+You can tweak and play with your newly deployed website. Feel free to browse through the sphinx documentation to tweak the outputs as per your requiremetns.
+
+## Pull Request
+
+If you have suggestion/improvements then please consider submitting a pull request or create an issue.

netlify.toml

@@ -0,0 +1,3 @@
+[build]
+  publish = "build/dirhtml"
+  command = "make dirhtml"

requirements.txt

@@ -0,0 +1,2 @@
+sphinx==4.3.1
+sphinx_rtd_theme==1.0.0

runtime.txt

@@ -0,0 +1 @@
+3.8

source/_static/custom.css

@@ -0,0 +1 @@
+/* include relevent additional css here */

source/_static/custom.js

@@ -0,0 +1,6 @@
+window.addEventListener('load', (event) => {
+    var menu = document.querySelector(".wy-menu ul li:first-child")
+    if (!menu.classList.contains("current")) {
+        menu.classList.add("current")
+    }
+});

source/conf.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+# Note that not all possible configuration values are present. All configuration
+# values have a default.
+
+# -- General configuration --
+project = 'Sphinx On Netlify'
+copyright = '2021, Seo Wings'
+author = 'seowings'
+
+master_doc = 'index'
+version = 'latest'
+pygments_style = 'sphinx'
+
+html_css_files = ['custom.css']
+html_js_files = ['custom.js']
+html_theme = 'sphinx_rtd_theme'
+html_baseurl = 'https://sphinx-netlify.netlify.app/'
+html_theme_options = {
+    'current_version': version,
+    "collapse_navigation": False,
+}
+html_context = {
+  'display_github': True,
+  'github_user': 'seowings',
+  'github_repo': 'sphinx-netlify',
+  'github_version': 'main/source/'
+}
+
+html_favicon = '_static/favicon.ico'
+html_static_path = ['_static']
+html_extra_path = ['robots.txt']
+
+# If true, links to the reST sources are added to the pages.
+html_show_sourcelink = True
+html_show_copyright = True
+
+htmlhelp_basename = 'ContinuousSphinxDoc'

source/index.rst

@@ -0,0 +1,27 @@
+=================
+Sphinx on Netlify
+=================
+
+Minimalistic Example of Hosting Sphnix on Neltify.
+
+Install
+========
+
+Just clone this repository and then delpying it from `Netlify`_. Nothing need to be changed and it will work out of the box.
+
+
+Tweaking
+========
+
+You can tweak and play with your newly deployed website. Feel free to browse through the `sphinx`_ documentation to tweak the outputs as per your requiremetns.
+
+Pull Request
+============
+
+If you have suggestion/improvements then please consider submitting a pull request or create an issue.
+
+.. toctree::
+   :maxdepth: 2
+
+.. _sphinx: https://www.sphinx-doc.org/en/master/
+.. _Netlify: https://www.netlify.com/