Fixed Issue With Documentation Environment (#165)

* Added example code to config file

* Added html context

* Mirrored a setup on GitHub

See: readthedocs/readthedocs.org#4912 (comment)

* Fixed typo

Author: jrg94

.readthedocs.yaml

@@ -6,10 +6,9 @@ build:
       python: "3.11"
    jobs:
       post_create_environment:
-         - pip install poetry
-         - poetry config virtualenvs.create false
+         - python -m pip install poetry
       post_install:
-         - poetry install --with docs
+         - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs
 
 sphinx:
    configuration: docs/conf.py

docs/conf.py

@@ -9,7 +9,6 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#
 import os
 import sys
 
@@ -48,9 +47,18 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-#
 html_theme = "sphinx_rtd_theme"
 
+# Adds "edit source" links
+# Source: https://docs.readthedocs.io/en/stable/guides/edit-source-links-sphinx.html
+html_context = {
+    "display_github": True, # Integrate GitHub
+    "github_user": "TheRenegadeCoder", # Username
+    "github_repo": "SnakeMD", # Repo name
+    "github_version": "main", # Version
+    "conf_py_path": "/docs/", # Path in the checkout to the docs root
+}
+
 # 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".
@@ -64,3 +72,12 @@
 intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
 
 html_theme_options = {"display_version": True}
+
+# -- ReadTheDocs Configuration
+
+# Set canonical URL from the Read the Docs Domain
+html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")
+
+# Tell Jinja2 templates the build is running on Read the Docs
+if os.environ.get("READTHEDOCS", "") == "True":
+    html_context["READTHEDOCS"] = True