Add initial Sphinx docs setup

.readthedocs.yml

@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  image: latest
+
+python:
+  version: 3.6
+  install:
+    - method: pip
+      path: .
+
+sphinx:
+  fail_on_warning: true

docs/conf.py

@@ -0,0 +1,106 @@
+import os
+
+here = os.path.dirname(__file__)
+top_level = os.path.dirname(here)
+
+# -- General configuration -----------------------------------------------------
+
+project = "django-local-settings"
+version = "2.0a4"  # Short version
+release = version  # Full version
+author_name = "Wyatt Baldwin"
+author_email = "self@wyattbaldwin.com"
+copyright = f"2014, 2021 {author_name} <{author_email}>"
+github_username = "wylee"
+github_url = f"https://github.com/{github_username}/{project}"
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.intersphinx",
+]
+
+templates_path = ["_templates"]
+
+source_suffix = ".rst"
+
+master_doc = "index"
+
+today_fmt = "%B %d, %Y"
+
+exclude_patterns = ["_build"]
+
+pygments_style = "sphinx"
+
+# reStructuredText options ------------------------------------------------
+
+# This makes `xyz` the same as ``xyz``.
+default_role = "literal"
+
+# This is appended to the bottom of all docs.
+rst_epilog = f"""
+.. |project| replace:: {project}
+.. |github_url| replace:: {github_url}
+"""
+
+# Options for intersphinx extension ---------------------------------------
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3.6", None),
+}
+
+# -- Options for HTML output -------------------------------------------
+
+html_theme = "alabaster"
+
+html_theme_options = {
+    "description": "Local/env settings for Django",
+    "github_user": github_username,
+    "github_repo": project,
+    "page_width": "1200px",
+    "fixed_sidebar": True,
+    "sidebar_width": "300px",
+    "extra_nav_links": {
+        "Source (GitHub)": github_url,
+    },
+}
+
+html_sidebars = {
+    "**": [
+        "about.html",
+        "navigation.html",
+        "searchbox.html",
+    ]
+}
+
+html_static_path = []
+
+html_last_updated_fmt = "%b %d, %Y"
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = f"{project}doc"
+
+
+# -- Options for LaTeX output ------------------------------------------
+
+latex_documents = [
+    (
+        "index",
+        f"{project}.tex",
+        f"{project} Documentation",
+        author_name,
+        "manual",
+    ),
+]
+
+# -- Options for manual page output ------------------------------------
+
+man_pages = [
+    (
+        "index",
+        project,
+        f"{project} Documentation",
+        [author_name],
+        1,
+    )
+]

docs/index.rst

@@ -0,0 +1,7 @@
+django-local-settings
++++++++++++++++++++++
+
+Overview
+========
+
+.. note:: Write docs!

pyproject.toml

@@ -13,6 +13,7 @@ packages = [
 ]
 
 include = [
+    "docs/*",
     "CHANGELOG.md",
     "LICENSE",
     "README.md",
@@ -29,6 +30,7 @@ black = "*"
 coverage = "*"
 flake8 = "*"
 runcommands = "*"
+sphinx = "*"
 tox = "*"
 
 [tool.poetry.scripts]